Package software.amazon.awssdk.services.cloudformation.model

Class SetTypeConfigurationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest
software.amazon.awssdk.services.cloudformation.model.SetTypeConfigurationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SetTypeConfigurationRequest.Builder,SetTypeConfigurationRequest>
@Generated("software.amazon.awssdk:codegen") public final class SetTypeConfigurationRequest extends CloudFormationRequest implements ToCopyableBuilder<SetTypeConfigurationRequest.Builder,SetTypeConfigurationRequest>

  • Method Details

    • typeArn

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

      public final String configuration()

      The configuration data for the extension in this account and Region.

      The configuration data must be formatted as JSON and validate against the extension's schema returned in the Schema response element of DescribeType.

      Returns:
      The configuration data for the extension in this account and Region.

      The configuration data must be formatted as JSON and validate against the extension's schema returned in the Schema response element of DescribeType.

    • configurationAlias

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

      public final String typeName()

      The name of the extension.

      Conditional: You must specify ConfigurationArn, or Type and TypeName.

      Returns:
      The name of the extension.

      Conditional: You must specify ConfigurationArn, or Type and TypeName.

    • type

      public final ThirdPartyType type()

      The type of extension.

      Conditional: You must specify ConfigurationArn, or Type and TypeName.

      If the service returns an enum value that is not available in the current SDK version, type will return ThirdPartyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of extension.

      Conditional: You must specify ConfigurationArn, or Type and TypeName.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of extension.

      Conditional: You must specify ConfigurationArn, or Type and TypeName.

      If the service returns an enum value that is not available in the current SDK version, type will return ThirdPartyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of extension.

      Conditional: You must specify ConfigurationArn, or Type and TypeName.

      See Also:

    • toBuilder

      public SetTypeConfigurationRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<SetTypeConfigurationRequest.Builder,SetTypeConfigurationRequest>
      Specified by:
      toBuilder in class CloudFormationRequest

    • builder

      public static SetTypeConfigurationRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo