software.amazon.awssdk.services.ssm.model

Class PutParameterRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.core.AmazonWebServiceRequest

software.amazon.awssdk.services.ssm.model.PutParameterRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, software.amazon.awssdk.utils.builder.ToCopyableBuilder<PutParameterRequest.Builder,PutParameterRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class PutParameterRequest
extends AmazonWebServiceRequest
implements software.amazon.awssdk.utils.builder.ToCopyableBuilder<PutParameterRequest.Builder,PutParameterRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutParameterRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.core.AmazonWebServiceRequest

NOOP

Method Summary

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)
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 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()
String	toString()
ParameterType	type() The type of parameter that you want to add to the system.
String	typeString() 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.

Methods inherited from class software.amazon.awssdk.core.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setSdkClientExecutionTimeout, withGeneralProgressListener, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public String name()

The name of the parameter that you want to add to the system.

Returns:

The name of the parameter that you want to add to the system.

description

public String description()

Information about the parameter that you want to add to the system

Returns:

Information about the parameter that you want to add to the system

value

public String value()

The parameter value that you want to add to the system.

Returns:

The parameter value that you want to add to the system.

type

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 typeString().

Returns:

The type of parameter that you want to add to the system.

See Also:

ParameterType

typeString

public String typeString()

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 typeString().

Returns:

The type of parameter that you want to add to the system.

See Also:

ParameterType

keyId

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.

Returns:

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.

overwrite

public Boolean overwrite()

Overwrite an existing parameter. If not specified, will default to "false".

Returns:

Overwrite an existing parameter. If not specified, will default to "false".

allowedPattern

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+$

Returns:

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+$

toBuilder

public PutParameterRequest.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<PutParameterRequest.Builder,PutParameterRequest>

builder

public static PutParameterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutParameterRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest