Activate a third-party public extension in your account

To activate a public extension for use in your account

1. Sign in to the AWS Management Console and open the AWS CloudFormation console at https://console.aws.amazon.com/cloudformation.

2. On the navigation bar at the top of the screen, choose your AWS Region.

3. From the navigation pane, under CloudFormation registry, choose Public extensions.

4. Use the Filter to choose the extension type, and choose Third party. (Extensions published by AWS are activated by default.)

5. Choose the extension, then choose Activate.

   If multiple versions of an extension are available, you can use the Version menu to choose the version of the extension you want to activate. The default is the most current version.

6. To activate the extension using an extension type alias:

   1. Choose Override default

   2. Enter the extension type alias you want to use with this extension. The alias must follow the recommended format for the extension type.

   For more information, see Use aliases to refer to extensions.

7. If you are enabling a private resource, you can specify the IAM role for CloudFormation to assume when invoking the extension.

8. Under Logging config, specify logging configuration information for an extension, if desired. For example:

   {
       "logRoleArn": "arn:aws:iam::account:role/rolename",
       "logGroupName": "log-group-name"
   }

   Logging configuration information isn't required but it's recommended for debugging purposes. To use logging configuration with Hooks, add the same trust policy as the execution role specified, so that the log role can write logs to your log group.

   logRoleArn and logGroupName key names are case-sensitive.

9. Under Versioning, Automatic updates, choose how to receive updates.

   • On – Automatically updates to the latest minor version. Major versions are updated manually.

   • Off – Never automatically update to the latest version. All versions are updated manually.

   For more information, see Automatically use new versions of extensions.

To specify the configuration data

1. For Configuration, choose Configure now, and then choose Activate extension.

   CloudFormation displays the Configure extension page. To view the current configuration schema for the extension, make sure View configuration schema is activated.

2. In the Configuration JSON text box, enter a JSON string that represents the configuration data you want to specify for this extension. The JSON you specify must validate against the extension's configuration schema.

3. Choose Configure extension.

1. For Configuration, choose Configure later, and then choose Activate extension.

2. After the extension is activated, you can configure it by navigating to the extension from the activated extensions page and providing the configuration data.

To activate a public Hook for use in your account (AWS CLI)

1. Get the ARN for your Hook and save it. You can get the ARN of a Hook using the AWS Management Console or AWS CLI. For more information see View the available and activated extensions in the CloudFormation registry.

   export HOOK_TYPE_ARN="arn:aws:cloudformation:us-west-2:123456789012:type/hook/Organization-Service-Hook/"

2. Use the set-type-configuration command to specify the configuration data. The JSON you pass for --configuration must validate against the Hook's configuration schema. To activate the Hook for all stack operations, you must set the HookInvocationStatus property to ENABLED in the HookConfiguration section.

   aws cloudformation set-type-configuration \
     --configuration "{"CloudFormationConfiguration":{"HookConfiguration":{"HookInvocationStatus": "ENABLED", "FailureMode": "FAIL", "Properties":{}}}}" \
     --type-arn $HOOK_TYPE_ARN --region us-west-2

   For more information on the HookConfiguration configuration options, see Hook configuration schema syntax reference in the AWS CloudFormation Hooks User Guide.

To activate a public extension for use in your account (AWS CLI)

• Use activate-type to activate the extension, and specify whether to auto update the extension whenever a new minor version of the extension is published.

  The example below specifies the public Amazon Resource Name (ARN) of a public extension to activate for this account. In addition, it specifies that CloudFormation updates the extension whenever a new minor version is published.

  aws cloudformation activate-type \
    --public-type-arn public_extension_ARN \
    --auto-update true --region us-west-2

  This command returns an ARN of the activated extension.

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