public static interface PutParameterRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<PutParameterRequest.Builder,PutParameterRequest>
| Modifier and Type | Method and Description |
|---|---|
PutParameterRequest.Builder |
allowedPattern(String allowedPattern)
A regular expression used to validate the parameter value.
|
PutParameterRequest.Builder |
description(String description)
Information about the parameter that you want to add to the system.
|
PutParameterRequest.Builder |
keyId(String keyId)
The KMS Key ID that you want to use to encrypt a parameter.
|
PutParameterRequest.Builder |
name(String name)
The fully qualified name of the parameter that you want to add to the system.
|
PutParameterRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
PutParameterRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
PutParameterRequest.Builder |
overwrite(Boolean overwrite)
Overwrite an existing parameter.
|
PutParameterRequest.Builder |
type(ParameterType type)
The type of parameter that you want to add to the system.
|
PutParameterRequest.Builder |
type(String type)
The type of parameter that you want to add to the system.
|
PutParameterRequest.Builder |
value(String value)
The parameter value that you want to add to the system.
|
buildoverrideConfigurationcopyapplyMutation, buildPutParameterRequest.Builder name(String name)
The fully qualified name of the parameter that you want to add to the system. The fully qualified name
includes the complete hierarchy of the parameter path and name. For example:
/Dev/DBServer/MySQL/db-string13
Naming Constraints:
Parameter names are case sensitive.
A parameter name must be unique within an AWS Region
A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).
Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/
A parameter name can't include spaces.
Parameter hierarchies are limited to a maximum depth of fifteen levels.
For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.
The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters.
name - The fully qualified name of the parameter that you want to add to the system. The fully qualified name
includes the complete hierarchy of the parameter path and name. For example:
/Dev/DBServer/MySQL/db-string13
Naming Constraints:
Parameter names are case sensitive.
A parameter name must be unique within an AWS Region
A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).
Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/
A parameter name can't include spaces.
Parameter hierarchies are limited to a maximum depth of fifteen levels.
For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.
The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters.
PutParameterRequest.Builder description(String description)
Information about the parameter that you want to add to the system. Optional but recommended.
Do not enter personally identifiable information in this field.
description - Information about the parameter that you want to add to the system. Optional but recommended.
Do not enter personally identifiable information in this field.
PutParameterRequest.Builder value(String value)
The parameter value that you want to add to the system.
value - The parameter value that you want to add to the system.PutParameterRequest.Builder type(String type)
The type of parameter that you want to add to the system.
Items in a StringList must be separated by a comma (,). You can't use other punctuation or
special character to escape items in the list. If you have a parameter value that requires a comma, then use
the String data type.
SecureString is not currently supported for AWS CloudFormation templates or in the China
Regions.
type - The type of parameter that you want to add to the system.
Items in a StringList must be separated by a comma (,). You can't use other punctuation
or special character to escape items in the list. If you have a parameter value that requires a comma,
then use the String data type.
SecureString is not currently supported for AWS CloudFormation templates or in the China
Regions.
ParameterType,
ParameterTypePutParameterRequest.Builder type(ParameterType type)
The type of parameter that you want to add to the system.
Items in a StringList must be separated by a comma (,). You can't use other punctuation or
special character to escape items in the list. If you have a parameter value that requires a comma, then use
the String data type.
SecureString is not currently supported for AWS CloudFormation templates or in the China
Regions.
type - The type of parameter that you want to add to the system.
Items in a StringList must be separated by a comma (,). You can't use other punctuation
or special character to escape items in the list. If you have a parameter value that requires a comma,
then use the String data type.
SecureString is not currently supported for AWS CloudFormation templates or in the China
Regions.
ParameterType,
ParameterTypePutParameterRequest.Builder keyId(String keyId)
The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service
(AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use
the SecureString data type.
If you don't specify a key ID, the system uses the default key associated with your AWS account.
To use your default AWS KMS key, choose the SecureString data type, and do not specify
the Key ID when you create the parameter. The system automatically populates Key ID
with your default KMS key.
To use a custom KMS key, choose the SecureString data type with the Key ID
parameter.
keyId - The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management
Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for
parameters that use the SecureString data type.
If you don't specify a key ID, the system uses the default key associated with your AWS account.
To use your default AWS KMS key, choose the SecureString data type, and do not
specify the Key ID when you create the parameter. The system automatically populates
Key ID with your default KMS key.
To use a custom KMS key, choose the SecureString data type with the Key ID
parameter.
PutParameterRequest.Builder overwrite(Boolean overwrite)
Overwrite an existing parameter. If not specified, will default to "false".
overwrite - Overwrite an existing parameter. If not specified, will default to "false".PutParameterRequest.Builder allowedPattern(String allowedPattern)
A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
allowedPattern - A regular expression used to validate the parameter value. For example, for String types with values
restricted to numbers, you can specify the following: AllowedPattern=^\d+$PutParameterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.PutParameterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.