Package software.amazon.awscdk.services.cloudformation

Class CfnTypeActivation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cloudformation.CfnTypeActivation
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.574Z") @Stability(Stable) public class CfnTypeActivation extends CfnResource implements IInspectable
A CloudFormation AWS::CloudFormation::TypeActivation.

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.services.cloudformation.*;
 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();

  • 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 Construct scope, @NotNull String id, @Nullable CfnTypeActivationProps props)
      Create a new AWS::CloudFormation::TypeActivation.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnTypeActivation

      @Stability(Stable) public CfnTypeActivation(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::CloudFormation::TypeActivation.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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 Number (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.

      Major versions released by the publisher must be manually updated.

      The default is true .

    • 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.

      Major versions released by the publisher must be manually updated.

      The default is true .

    • 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.

      Major versions released by the publisher must be manually updated.

      The default is true .

    • 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.

      The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

      You can specify MajorVersion or VersionBump , but not both.

    • 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.

      The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

      You can specify MajorVersion or VersionBump , but not both.

    • getPublicTypeArn

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

      Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

    • setPublicTypeArn

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

      Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

    • getPublisherId

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

      Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

    • setPublisherId

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

      Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

    • getType

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

      Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

    • setType

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

      Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

    • getTypeName

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

      Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

    • setTypeName

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

      Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

    • getTypeNameAlias

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

      If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

      An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.

    • setTypeNameAlias

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

      If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

      An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.

    • getVersionBump

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

      You can also use this parameter to update the value of AutoUpdate .

      • MAJOR : CloudFormation updates the extension to the newest major version, if one is available.
      • MINOR : CloudFormation updates the extension to the newest minor version, if one is 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.

      You can also use this parameter to update the value of AutoUpdate .

      • MAJOR : CloudFormation updates the extension to the newest major version, if one is available.
      • MINOR : CloudFormation updates the extension to the newest minor version, if one is available.