Class SetTypeConfigurationRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SetTypeConfigurationRequest.Builder,
SetTypeConfigurationRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The configuration data for the extension, in this account and Region.final String
An alias by which to refer to this extension configuration data.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 int
hashCode()
static Class
<? extends SetTypeConfigurationRequest.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.final ThirdPartyType
type()
The type of extension.final String
typeArn()
The Amazon Resource Name (ARN) for the extension, in this account and Region.final String
The type of extension.final String
typeName()
The name of the extension.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
typeArn
The Amazon Resource Name (ARN) for the extension, in this account and Region.
For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.
Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.
- Returns:
- The Amazon Resource Name (ARN) for the extension, in this account and Region.
For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.
Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.
-
configuration
The configuration data for the extension, in this account and Region.
The configuration data must be formatted as JSON, and validate against the schema returned in the
ConfigurationSchema
response element of DescribeType. For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.- Returns:
- The configuration data for the extension, in this account and Region.
The configuration data must be formatted as JSON, and validate against the schema returned in the
ConfigurationSchema
response element of DescribeType. For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.
-
configurationAlias
An alias by which to refer to this extension configuration data.
Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.
- Returns:
- An alias by which to refer to this extension configuration data.
Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.
-
typeName
The name of the extension.
Conditional: You must specify
ConfigurationArn
, orType
andTypeName
.- Returns:
- The name of the extension.
Conditional: You must specify
ConfigurationArn
, orType
andTypeName
.
-
type
The type of extension.
Conditional: You must specify
ConfigurationArn
, orType
andTypeName
.If the service returns an enum value that is not available in the current SDK version,
type
will returnThirdPartyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of extension.
Conditional: You must specify
ConfigurationArn
, orType
andTypeName
. - See Also:
-
typeAsString
The type of extension.
Conditional: You must specify
ConfigurationArn
, orType
andTypeName
.If the service returns an enum value that is not available in the current SDK version,
type
will returnThirdPartyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of extension.
Conditional: You must specify
ConfigurationArn
, orType
andTypeName
. - See Also:
-
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<SetTypeConfigurationRequest.Builder,
SetTypeConfigurationRequest> - Specified by:
toBuilder
in classCloudFormationRequest
- 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
-