Class CreateServiceActionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateServiceActionRequest.Builder,
CreateServiceActionRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The language code.builder()
final Map
<ServiceActionDefinitionKey, String> The self-service action definition.The self-service action definition.The service action definition type.final String
The service action definition type.final String
The self-service action description.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Definition property.final int
hashCode()
final String
A unique identifier that you provide to ensure idempotency.final String
name()
The self-service action name.static Class
<? extends CreateServiceActionRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The self-service action name.
- Returns:
- The self-service action name.
-
definitionType
The service action definition type. For example,
SSM_AUTOMATION
.If the service returns an enum value that is not available in the current SDK version,
definitionType
will returnServiceActionDefinitionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdefinitionTypeAsString()
.- Returns:
- The service action definition type. For example,
SSM_AUTOMATION
. - See Also:
-
definitionTypeAsString
The service action definition type. For example,
SSM_AUTOMATION
.If the service returns an enum value that is not available in the current SDK version,
definitionType
will returnServiceActionDefinitionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdefinitionTypeAsString()
.- Returns:
- The service action definition type. For example,
SSM_AUTOMATION
. - See Also:
-
definition
The self-service action definition. Can be one of the following:
- Name
-
The name of the Amazon Web Services Systems Manager document (SSM document). For example,
AWS-RestartEC2Instance
.If you are using a shared SSM document, you must provide the ARN instead of the name.
- Version
-
The Amazon Web Services Systems Manager automation document version. For example,
"Version": "1"
- AssumeRole
-
The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example,
"AssumeRole": "arn:aws:iam::12345678910:role/ActionRole"
.To reuse the provisioned product launch role, set to
"AssumeRole": "LAUNCH_ROLE"
. - Parameters
-
The list of parameters in JSON format.
For example:
[{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}]
or[{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}]
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDefinition()
method.- Returns:
- The self-service action definition. Can be one of the following:
- Name
-
The name of the Amazon Web Services Systems Manager document (SSM document). For example,
AWS-RestartEC2Instance
.If you are using a shared SSM document, you must provide the ARN instead of the name.
- Version
-
The Amazon Web Services Systems Manager automation document version. For example,
"Version": "1"
- AssumeRole
-
The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example,
"AssumeRole": "arn:aws:iam::12345678910:role/ActionRole"
.To reuse the provisioned product launch role, set to
"AssumeRole": "LAUNCH_ROLE"
. - Parameters
-
The list of parameters in JSON format.
For example:
[{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}]
or[{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}]
.
-
hasDefinition
public final boolean hasDefinition()For responses, this returns true if the service returned a value for the Definition property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
definitionAsStrings
The self-service action definition. Can be one of the following:
- Name
-
The name of the Amazon Web Services Systems Manager document (SSM document). For example,
AWS-RestartEC2Instance
.If you are using a shared SSM document, you must provide the ARN instead of the name.
- Version
-
The Amazon Web Services Systems Manager automation document version. For example,
"Version": "1"
- AssumeRole
-
The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example,
"AssumeRole": "arn:aws:iam::12345678910:role/ActionRole"
.To reuse the provisioned product launch role, set to
"AssumeRole": "LAUNCH_ROLE"
. - Parameters
-
The list of parameters in JSON format.
For example:
[{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}]
or[{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}]
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDefinition()
method.- Returns:
- The self-service action definition. Can be one of the following:
- Name
-
The name of the Amazon Web Services Systems Manager document (SSM document). For example,
AWS-RestartEC2Instance
.If you are using a shared SSM document, you must provide the ARN instead of the name.
- Version
-
The Amazon Web Services Systems Manager automation document version. For example,
"Version": "1"
- AssumeRole
-
The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example,
"AssumeRole": "arn:aws:iam::12345678910:role/ActionRole"
.To reuse the provisioned product launch role, set to
"AssumeRole": "LAUNCH_ROLE"
. - Parameters
-
The list of parameters in JSON format.
For example:
[{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}]
or[{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}]
.
-
description
The self-service action description.
- Returns:
- The self-service action description.
-
acceptLanguage
The language code.
-
jp
- Japanese -
zh
- Chinese
- Returns:
- The language code.
-
jp
- Japanese -
zh
- Chinese
-
-
-
idempotencyToken
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
- Returns:
- A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateServiceActionRequest.Builder,
CreateServiceActionRequest> - Specified by:
toBuilder
in classServiceCatalogRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-