activate-type¶

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 SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide .

Synopsis¶

  activate-type
[--type <value>]
[--public-type-arn <value>]
[--publisher-id <value>]
[--type-name <value>]
[--type-name-alias <value>]
[--auto-update | --no-auto-update]
[--logging-config <value>]
[--execution-role-arn <value>]
[--version-bump <value>]
[--major-version <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--type (string)

The extension type.

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

Possible values:

RESOURCE

MODULE

HOOK

--public-type-arn (string)

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

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

--publisher-id (string)

The ID of the extension publisher.

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

--type-name (string)

The name of the extension.

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

--type-name-alias (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.

--auto-update | --no-auto-update (boolean)

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 .

--logging-config (structure)

Contains logging configuration information for an extension.

LogRoleArn -> (string)

The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.

LogGroupName -> (string)

The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension’s handlers.

Shorthand Syntax:

LogRoleArn=string,LogGroupName=string

JSON Syntax:

{
  "LogRoleArn": "string",
  "LogGroupName": "string"
}

--execution-role-arn (string)

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

--version-bump (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.

Possible values:

MAJOR

MINOR

--major-version (long)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To activate a type

The following activate-type example activates a public third-party extension, making it available for use in stack templates.

aws cloudformation activate-type \
    --region us-west-2 \
    --type RESOURCE \
    --type-name Example::Test::1234567890abcdef0 \
    --type-name-alias Example::Test::Alias

Output:

{
    "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/Example-Test-Alias"
}

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

Output¶

Arn -> (string)

The Amazon Resource Name (ARN) of the activated extension, in this account and region.

Table of Contents

Feedback

User Guide