Using private extensions in CloudFormation

1. (Optional) Configure your default Amazon Web Services Region name to us-west-2, by submitting the configure operation.

   aws configure
   AWS Access Key ID [None]: <Your Access Key ID>
   AWS Secret Access Key [None]: <Your Secret Key>
   Default region name [None]: us-west-2
   Default output format [None]: json

2. (Optional) The following command builds and packages your hook project without registering it.

   $ cfn submit --dry-run

3. Register your hook by using the CloudFormation CLI cfn submit.

   cfn submit --set-default

   The command returns the following command.

   {‘ProgressStatus’: ‘COMPLETE’}

   Results: You've successfully registered your hook.

1. Locate the Amazon S3 bucket that contains the project package for the private extension you want to register in your account.

2. Use the register-type command to register the extension in your account:

   RegisterType is an asynchronous operation, and returns a registration token you can use to track the progress of your registration request.

   Note

   If your extension calls Amazon APIs as part of its functionality, you must create an IAM execution role that includes the necessary permissions to call those Amazon APIs, and provision that execution role in your account. You can then specify this execution role using the --execution-role-arn parameter. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.

   For example, the following command registers the My::Resource::Example resource type in the current Amazon Web Services account:

   aws cloudformation register-type --type-name My::Resource::Example --schema-handler-package [s3 object path] --type RESOURCE                
   {
       "RegistrationToken": "f5525280-104e-4d35-bef5-8f1fexample"
   }

3. Optional: Use the registration token with the describe-type-registration command to track the progress of your registration request.

   When CloudFormation completes the registration request, it sets the progress status of the request to COMPLETE.

   The following example uses the registration token returned by the describe-type-registration command above to return registration status information.

   aws cloudformation describe-type-registration --registration-token f5525280-104e-4d35-bef5-8f1fexample
   {
       "ProgressStatus": "COMPLETE",
       "TypeArn": "arn:aws:cloudformation:us-east-1:012345678910:type/resource/My-Resource-Example",
       "Description": "Deployment is currently in DEPLOY_STAGE of status COMPLETED; ",
       "TypeVersionArn": "arn:aws:cloudformation:us-east-1:111122223333:type/resource/My-Resource-Example/00000001"
   }

To view the current configuration data for an extension in the CloudFormation console

1. Use the CloudFormation registry to find the extension.

2. Choose the extension to view the extension details.

3. On the extension details page, choose the Configuration tab.

4. Expand the Configuration schema tab to see the configuration schema defined for the extension.

5. Expand the Configuration tab to see the current configuration that you have set for this extension.

To view the current configuration data for an extension in the Amazon CLI

• Use the describe-type command to return detailed information about the extension. The ConfigurationSchema element of the output contains the current configuration definition of the extension in a given Region.

  Alternatively, use the batch-describe-type-configurations command to return configuration data about multiple extensions.

1. Use the CloudFormation registry to find the extension in your account's activated extensions.

2. Select the extension to view the extension details.

3. On the extension details page, from the Configuration tab, select Edit configuration.

   Alternatively, from Actions, select Edit, and then select Edit configuration.

   CloudFormation displays the Configure extension page. Make sure that View configuration schema is toggled on to see the extension's current configuration definition schema.

4. In the Configuration JSON text box, enter a JSON string that represents the configuration schema you want to set for this extension. It must validate against the schema defined in Configuration schema.

5. Select Configure extension.

• Use the set-type-configuration command to specify the configuration to be used with the extension in your account and Region.

  The JSON you pass for --configuration must validate against the extension's configuration definition schema. The following is an example of a set-type-configuration command that specifies the configuration.

  aws cloudformation set-type-configuration \
      --region us-west-2 \
      --type RESOURCE \
      --type-name My::Resource::Example \
      --configuration-alias default \
      --configuration "{"CredentialKey": "testUserCredential"}"