Activate Type

cloudformation_activate_type

R Documentation

Activates a public third-party extension, making it available for use in stack templates

Description

Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.

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

Usage

cloudformation_activate_type(Type, PublicTypeArn, PublisherId, TypeName,
  TypeNameAlias, AutoUpdate, LoggingConfig, ExecutionRoleArn, VersionBump,
  MajorVersion)

Arguments

Type

The extension type.

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

PublicTypeArn

The Amazon Resource Name (ARN) of the public extension.

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

PublisherId

The ID of the extension publisher.

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

TypeName

The name of the extension.

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

TypeNameAlias

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.

AutoUpdate

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.

LoggingConfig

Contains logging configuration information for an extension.

ExecutionRoleArn

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

VersionBump

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.

MajorVersion

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.

Value

A list with the following syntax:

list(
  Arn = "string"
)

Request syntax

svc$activate_type(
  Type = "RESOURCE"|"MODULE"|"HOOK",
  PublicTypeArn = "string",
  PublisherId = "string",
  TypeName = "string",
  TypeNameAlias = "string",
  AutoUpdate = TRUE|FALSE,
  LoggingConfig = list(
    LogRoleArn = "string",
    LogGroupName = "string"
  ),
  ExecutionRoleArn = "string",
  VersionBump = "MAJOR"|"MINOR",
  MajorVersion = 123
)