Skip to main content

resource_version

Gets an individual resource_version resource

Overview

Nameresource_version
TypeResource
Descriptionresource_version
Idawscc.cloudformation.resource_version

Fields

NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the type, here the ResourceVersion. This is used to uniquely identify a ResourceVersion resource
type_arnstringThe Amazon Resource Name (ARN) of the type without the versionID.
execution_role_arnstringThe 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.
is_default_versionbooleanIndicates if this type version is the current default version
logging_configobjectSpecifies logging configuration information for a type.
provisioning_typestringThe provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
schema_handler_packagestringA url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.<br/><br/>For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
version_idstringThe ID of the version of the type represented by this resource instance.
visibilitystringThe scope at which the type is visible and usable in CloudFormation operations.<br/><br/>Valid values include:<br/><br/>PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.<br/><br/>PUBLIC: The type is publically visible and usable within any Amazon account.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
arn,
type_arn,
execution_role_arn,
is_default_version,
logging_config,
provisioning_type,
schema_handler_package,
type_name,
version_id,
visibility
FROM awscc.cloudformation.resource_version
WHERE data__Identifier = '<Arn>';

Permissions

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

Read

cloudformation:DescribeType

Delete

cloudformation:DeregisterType,
cloudformation:DescribeType