software.amazon.awssdk.services.servicecatalog.model

Class CreateServiceActionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.servicecatalog.model.ServiceCatalogRequest

software.amazon.awssdk.services.servicecatalog.model.CreateServiceActionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateServiceActionRequest.Builder,CreateServiceActionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateServiceActionRequest
extends ServiceCatalogRequest
implements ToCopyableBuilder<CreateServiceActionRequest.Builder,CreateServiceActionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateServiceActionRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	acceptLanguage() The language code.
static CreateServiceActionRequest.Builder	builder()
Map<ServiceActionDefinitionKey,String>	definition() The self-service action definition.
Map<String,String>	definitionAsStrings() The self-service action definition.
ServiceActionDefinitionType	definitionType() The service action definition type.
String	definitionTypeAsString() The service action definition type.
String	description() The self-service action description.
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	idempotencyToken() A unique identifier that you provide to ensure idempotency.
String	name() The self-service action name.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateServiceActionRequest.Builder>	serializableBuilderClass()
CreateServiceActionRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public String name()

The self-service action name.

Returns:

The self-service action name.

definitionType

public ServiceActionDefinitionType 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 return ServiceActionDefinitionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from definitionTypeAsString().

Returns:

The service action definition type. For example, SSM_AUTOMATION.

See Also:

ServiceActionDefinitionType

definitionTypeAsString

public String 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 return ServiceActionDefinitionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from definitionTypeAsString().

Returns:

The service action definition type. For example, SSM_AUTOMATION.

See Also:

ServiceActionDefinitionType

definition

public Map<ServiceActionDefinitionKey,String> definition()

The self-service action definition. Can be one of the following:

Name

The name of the AWS Systems Manager Document. For example, AWS-RestartEC2Instance.

Version

The AWS 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\"}].

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The self-service action definition. Can be one of the following:

Name

The name of the AWS Systems Manager Document. For example, AWS-RestartEC2Instance.

Version

The AWS 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\"}].

definitionAsStrings

public Map<String,String> definitionAsStrings()

The self-service action definition. Can be one of the following:

Name

The name of the AWS Systems Manager Document. For example, AWS-RestartEC2Instance.

Version

The AWS 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\"}].

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The self-service action definition. Can be one of the following:

Name

The name of the AWS Systems Manager Document. For example, AWS-RestartEC2Instance.

Version

The AWS 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\"}].

description

public String description()

The self-service action description.

Returns:

The self-service action description.

acceptLanguage

public String acceptLanguage()

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

Returns:

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

idempotencyToken

public String 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

public CreateServiceActionRequest.Builder 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 interface ToCopyableBuilder<CreateServiceActionRequest.Builder,CreateServiceActionRequest>

Specified by:

toBuilder in class ServiceCatalogRequest

Returns:

a builder for type T

builder

public static CreateServiceActionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateServiceActionRequest.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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

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

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.