@Generated(value="software.amazon.awssdk:codegen") public final class PutParameterRequest extends SsmRequest implements ToCopyableBuilder<PutParameterRequest.Builder,PutParameterRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
PutParameterRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
allowedPattern()
A regular expression used to validate the parameter value.
|
static PutParameterRequest.Builder |
builder() |
String |
description()
Information about the parameter that you want to add to the system.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
keyId()
The KMS Key ID that you want to use to encrypt a parameter when you choose the SecureString data type.
|
String |
name()
The fully qualified name of the parameter that you want to add to the system.
|
Boolean |
overwrite()
Overwrite an existing parameter.
|
static Class<? extends PutParameterRequest.Builder> |
serializableBuilderClass() |
PutParameterRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
ParameterType |
type()
The type of parameter that you want to add to the system.
|
String |
typeAsString()
The type of parameter that you want to add to the system.
|
String |
value()
The parameter value that you want to add to the system.
|
overrideConfiguration
copy
public 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
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.
/Dev/DBServer/MySQL/db-string13
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.
public String description()
Information about the parameter that you want to add to the system.
public String value()
The parameter value that you want to add to the system.
public ParameterType type()
The type of parameter that you want to add to the system.
If the service returns an enum value that is not available in the current SDK version, type
will return
ParameterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
ParameterType
public String typeAsString()
The type of parameter that you want to add to the system.
If the service returns an enum value that is not available in the current SDK version, type
will return
ParameterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
ParameterType
public String keyId()
The KMS Key ID that you want to use to encrypt a parameter when you choose the SecureString data type. If you don't specify a key ID, the system uses the default key associated with your AWS account.
public Boolean overwrite()
Overwrite an existing parameter. If not specified, will default to "false".
public 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+$
public PutParameterRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<PutParameterRequest.Builder,PutParameterRequest>
toBuilder
in class SsmRequest
public static PutParameterRequest.Builder builder()
public static Class<? extends PutParameterRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.