AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::CloudFormation::TypeActivation

CfnTypeActivation

The `AWS::CloudFormation::TypeActivation` resource activates a public third-party extension, making it available for use in stack templates. For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *CloudFormation User Guide* .

Import

import { CfnTypeActivation } from 'aws-cdk-lib/aws-cloudformation';

Or use the module namespace:

import * as cloudformation from 'aws-cdk-lib/aws-cloudformation';
// cloudformation.CfnTypeActivation

Properties

Configuration passed to the constructor as CfnTypeActivationProps.

autoUpdateOptional
boolean | IResolvable

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

executionRoleArnOptional
string

The name of the IAM execution role to use to activate the extension.

loggingConfigOptional
IResolvable | LoggingConfigProperty

Specifies logging configuration information for an extension.

majorVersionOptional
string

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.

publicTypeArnOptional
string

The Amazon Resource Number (ARN) of the public extension. Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .

publisherIdOptional
string

The ID of the extension publisher. Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .

typeOptional
string

The extension type. Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .

typeNameOptional
string

The name of the extension. Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .

typeNameAliasOptional
string

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.

versionBumpOptional
string

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::CloudFormation::TypeActivationView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-cloudformation
CFN TypeAWS::CloudFormation::TypeActivation
Properties10

Related Constructs

Explore This Service

External Links