type_activations

Creates, updates, deletes or gets a type_activation resource or lists type_activations in a region

Overview

Name	type_activations
Type	Resource
Description	Enable a resource that has been published in the CloudFormation Registry.
Id	awscc.cloudformation.type_activations

Fields

get (all properties)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the extension.
execution_role_arn	string	The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
publisher_id	string	The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
▶logging_config	object	Specifies logging configuration information for a type.
public_type_arn	string	The Amazon Resource Number (ARN) assigned to the public extension upon publication
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.
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, you must then use the alias to refer to the extension in your templates.
version_bump	string	Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled
major_version	string	The Major Version of the type you want to enable
type_name	string	The name of the type being registered. We recommend that type names adhere to the following pattern: company_or_organization::service::type.
type	string	The kind of extension
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the extension.
region	string	AWS region.

For more information, see AWS::CloudFormation::TypeActivation.

Methods

Name	Resource	Accessible by	Required Params
create_resource	type_activations	INSERT	region
delete_resource	type_activations	DELETE	Identifier, region
update_resource	type_activations	UPDATE	Identifier, PatchDocument, region
list_resources	type_activations_list_only	SELECT	region
get_resource	type_activations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual type_activation.

SELECT
  region,
  arn,
  execution_role_arn,
  publisher_id,
  logging_config,
  public_type_arn,
  auto_update,
  type_name_alias,
  version_bump,
  major_version,
  type_name,
  type
FROM awscc.cloudformation.type_activations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all type_activations in a region.

SELECT
  region,
  arn
FROM awscc.cloudformation.type_activations_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new type_activation resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.cloudformation.type_activations (
  ExecutionRoleArn,
  PublisherId,
  LoggingConfig,
  PublicTypeArn,
  AutoUpdate,
  TypeNameAlias,
  VersionBump,
  MajorVersion,
  TypeName,
  Type,
  region
)
SELECT
  '{{ execution_role_arn }}',
  '{{ publisher_id }}',
  '{{ logging_config }}',
  '{{ public_type_arn }}',
  '{{ auto_update }}',
  '{{ type_name_alias }}',
  '{{ version_bump }}',
  '{{ major_version }}',
  '{{ type_name }}',
  '{{ type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cloudformation.type_activations (
  ExecutionRoleArn,
  PublisherId,
  LoggingConfig,
  PublicTypeArn,
  AutoUpdate,
  TypeNameAlias,
  VersionBump,
  MajorVersion,
  TypeName,
  Type,
  region
)
SELECT
  '{{ execution_role_arn }}',
  '{{ publisher_id }}',
  '{{ logging_config }}',
  '{{ public_type_arn }}',
  '{{ auto_update }}',
  '{{ type_name_alias }}',
  '{{ version_bump }}',
  '{{ major_version }}',
  '{{ type_name }}',
  '{{ type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: type_activation
  props:
    - name: execution_role_arn
      value: '{{ execution_role_arn }}'
    - name: publisher_id
      value: '{{ publisher_id }}'
    - name: logging_config
      value:
        log_group_name: '{{ log_group_name }}'
        log_role_arn: '{{ log_role_arn }}'
    - name: public_type_arn
      value: '{{ public_type_arn }}'
    - name: auto_update
      value: '{{ auto_update }}'
    - name: type_name_alias
      value: '{{ type_name_alias }}'
    - name: version_bump
      value: '{{ version_bump }}'
    - name: major_version
      value: '{{ major_version }}'
    - name: type_name
      value: '{{ type_name }}'
    - name: type
      value: '{{ type }}'

UPDATE example

Use the following StackQL query and manifest file to update a type_activation resource, using stack-deploy.

/*+ update */
UPDATE awscc.cloudformation.type_activations
SET PatchDocument = string('{{ {
    "ExecutionRoleArn": execution_role_arn,
    "PublisherId": publisher_id,
    "PublicTypeArn": public_type_arn,
    "AutoUpdate": auto_update,
    "TypeNameAlias": type_name_alias,
    "VersionBump": version_bump,
    "MajorVersion": major_version,
    "TypeName": type_name,
    "Type": type
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.cloudformation.type_activations
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the type_activations resource, the following permissions are required:

Create

cloudformation:ActivateType,
cloudformation:DescribeType,
iam:PassRole

Update

cloudformation:ActivateType,
cloudformation:DescribeType,
iam:PassRole

Read

cloudformation:DescribeType

Delete

cloudformation:DeactivateType,
cloudformation:DescribeType

List

cloudformation:ListTypes