Package software.amazon.awscdk

Class CfnTypeActivation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.CfnTypeActivation
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:33:56.292Z") @Stability(Stable) public class CfnTypeActivation extends CfnResource implements IInspectable
Activates a public third-party extension, making it available for use in stack templates.

For more information, see Using public extensions in the AWS CloudFormation User Guide .

Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 CfnTypeActivation cfnTypeActivation = CfnTypeActivation.Builder.create(this, "MyCfnTypeActivation")
         .autoUpdate(false)
         .executionRoleArn("executionRoleArn")
         .loggingConfig(LoggingConfigProperty.builder()
                 .logGroupName("logGroupName")
                 .logRoleArn("logRoleArn")
                 .build())
         .majorVersion("majorVersion")
         .publicTypeArn("publicTypeArn")
         .publisherId("publisherId")
         .type("type")
         .typeName("typeName")
         .typeNameAlias("typeNameAlias")
         .versionBump("versionBump")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTypeActivation

      protected CfnTypeActivation(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTypeActivation

      protected CfnTypeActivation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTypeActivation

      @Stability(Stable) public CfnTypeActivation(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnTypeActivationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnTypeActivation

      @Stability(Stable) public CfnTypeActivation(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the activated extension, in this account and Region.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAutoUpdate

      @Stability(Stable) @Nullable public Object getAutoUpdate()
      Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.

    • setAutoUpdate

      @Stability(Stable) public void setAutoUpdate(@Nullable Boolean value)
      Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.

    • setAutoUpdate

      @Stability(Stable) public void setAutoUpdate(@Nullable IResolvable value)
      Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.

    • getExecutionRoleArn

      @Stability(Stable) @Nullable public String getExecutionRoleArn()
      The name of the IAM execution role to use to activate the extension.

    • setExecutionRoleArn

      @Stability(Stable) public void setExecutionRoleArn(@Nullable String value)
      The name of the IAM execution role to use to activate the extension.

    • getLoggingConfig

      @Stability(Stable) @Nullable public Object getLoggingConfig()
      Specifies logging configuration information for an extension.

    • setLoggingConfig

      @Stability(Stable) public void setLoggingConfig(@Nullable IResolvable value)
      Specifies logging configuration information for an extension.

    • setLoggingConfig

      @Stability(Stable) public void setLoggingConfig(@Nullable CfnTypeActivation.LoggingConfigProperty value)
      Specifies logging configuration information for an extension.

    • getMajorVersion

      @Stability(Stable) @Nullable public String getMajorVersion()
      The major version of this extension you want to activate, if multiple major versions are available.

    • setMajorVersion

      @Stability(Stable) public void setMajorVersion(@Nullable String value)
      The major version of this extension you want to activate, if multiple major versions are available.

    • getPublicTypeArn

      @Stability(Stable) @Nullable public String getPublicTypeArn()
      The Amazon Resource Number (ARN) of the public extension.

    • setPublicTypeArn

      @Stability(Stable) public void setPublicTypeArn(@Nullable String value)
      The Amazon Resource Number (ARN) of the public extension.

    • getPublisherId

      @Stability(Stable) @Nullable public String getPublisherId()
      The ID of the extension publisher.

    • setPublisherId

      @Stability(Stable) public void setPublisherId(@Nullable String value)
      The ID of the extension publisher.

    • getType

      @Stability(Stable) @Nullable public String getType()
      The extension type.

    • setType

      @Stability(Stable) public void setType(@Nullable String value)
      The extension type.

    • getTypeName

      @Stability(Stable) @Nullable public String getTypeName()
      The name of the extension.

    • setTypeName

      @Stability(Stable) public void setTypeName(@Nullable String value)
      The name of the extension.

    • getTypeNameAlias

      @Stability(Stable) @Nullable public String getTypeNameAlias()
      An alias to assign to the public extension, in this account and Region.

    • setTypeNameAlias

      @Stability(Stable) public void setTypeNameAlias(@Nullable String value)
      An alias to assign to the public extension, in this account and Region.

    • getVersionBump

      @Stability(Stable) @Nullable public String getVersionBump()
      Manually updates a previously-activated type to a new major or minor version, if available.

    • setVersionBump

      @Stability(Stable) public void setVersionBump(@Nullable String value)
      Manually updates a previously-activated type to a new major or minor version, if available.