software.amazon.awssdk.services.ssm.model

Interface ParameterMetadata.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ParameterMetadata.Builder,ParameterMetadata>, SdkBuilder<ParameterMetadata.Builder,ParameterMetadata>, SdkPojo

Enclosing class:

ParameterMetadata

public static interface ParameterMetadata.Builder
extends SdkPojo, CopyableBuilder<ParameterMetadata.Builder,ParameterMetadata>

Method Summary

Modifier and Type	Method and Description
ParameterMetadata.Builder	allowedPattern(String allowedPattern) A parameter name can include only the following letters and symbols.
ParameterMetadata.Builder	dataType(String dataType) The data type of the parameter, such as text or aws:ec2:image.
ParameterMetadata.Builder	description(String description) Description of the parameter actions.
ParameterMetadata.Builder	keyId(String keyId) The ID of the query key used for this parameter.
ParameterMetadata.Builder	lastModifiedDate(Instant lastModifiedDate) Date the parameter was last changed or updated.
ParameterMetadata.Builder	lastModifiedUser(String lastModifiedUser) Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.
ParameterMetadata.Builder	name(String name) The parameter name.
ParameterMetadata.Builder	policies(Collection<ParameterInlinePolicy> policies) A list of policies associated with a parameter.
ParameterMetadata.Builder	policies(Consumer<ParameterInlinePolicy.Builder>... policies) A list of policies associated with a parameter.
ParameterMetadata.Builder	policies(ParameterInlinePolicy... policies) A list of policies associated with a parameter.
ParameterMetadata.Builder	tier(ParameterTier tier) The parameter tier.
ParameterMetadata.Builder	tier(String tier) The parameter tier.
ParameterMetadata.Builder	type(ParameterType type) The type of parameter.
ParameterMetadata.Builder	type(String type) The type of parameter.
ParameterMetadata.Builder	version(Long version) The parameter version.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

ParameterMetadata.Builder name(String name)

The parameter name.

Parameters:

name - The parameter name.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

ParameterMetadata.Builder type(String type)

The type of parameter. Valid parameter types include the following: String, StringList, and SecureString.

Parameters:

type - The type of parameter. Valid parameter types include the following: String, StringList, and SecureString.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParameterType, ParameterType

type

ParameterMetadata.Builder type(ParameterType type)

The type of parameter. Valid parameter types include the following: String, StringList, and SecureString.

Parameters:

type - The type of parameter. Valid parameter types include the following: String, StringList, and SecureString.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParameterType, ParameterType

keyId

ParameterMetadata.Builder keyId(String keyId)

The ID of the query key used for this parameter.

Parameters:

keyId - The ID of the query key used for this parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastModifiedDate

ParameterMetadata.Builder lastModifiedDate(Instant lastModifiedDate)

Date the parameter was last changed or updated.

Parameters:

lastModifiedDate - Date the parameter was last changed or updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastModifiedUser

ParameterMetadata.Builder lastModifiedUser(String lastModifiedUser)

Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.

Parameters:

lastModifiedUser - Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

ParameterMetadata.Builder description(String description)

Description of the parameter actions.

Parameters:

description - Description of the parameter actions.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowedPattern

ParameterMetadata.Builder allowedPattern(String allowedPattern)

A parameter name can include only the following letters and symbols.

a-zA-Z0-9_.-

Parameters:

allowedPattern - A parameter name can include only the following letters and symbols.

a-zA-Z0-9_.-

Returns:

Returns a reference to this object so that method calls can be chained together.

version

ParameterMetadata.Builder version(Long version)

The parameter version.

Parameters:

version - The parameter version.

Returns:

Returns a reference to this object so that method calls can be chained together.

tier

ParameterMetadata.Builder tier(String tier)

The parameter tier.

Parameters:

tier - The parameter tier.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParameterTier, ParameterTier

tier

ParameterMetadata.Builder tier(ParameterTier tier)

The parameter tier.

Parameters:

tier - The parameter tier.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParameterTier, ParameterTier

policies

ParameterMetadata.Builder policies(Collection<ParameterInlinePolicy> policies)

A list of policies associated with a parameter.

Parameters:

policies - A list of policies associated with a parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

policies

ParameterMetadata.Builder policies(ParameterInlinePolicy... policies)

A list of policies associated with a parameter.

Parameters:

policies - A list of policies associated with a parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

policies

ParameterMetadata.Builder policies(Consumer<ParameterInlinePolicy.Builder>... policies)

A list of policies associated with a parameter.

This is a convenience method that creates an instance of the ParameterInlinePolicy.Builder avoiding the need to create one manually via ParameterInlinePolicy.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #policies(List).

Parameters:

policies - a consumer that will call methods on ParameterInlinePolicy.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#policies(java.util.Collection)

dataType

ParameterMetadata.Builder dataType(String dataType)

The data type of the parameter, such as text or aws:ec2:image. The default is text.

Parameters:

dataType - The data type of the parameter, such as text or aws:ec2:image. The default is text.

Returns:

Returns a reference to this object so that method calls can be chained together.