AWS::CloudFormation::ResourceVersionCfnResourceVersion
The `AWS::CloudFormation::ResourceVersion` resource registers a resource version with the CloudFormation registry. Registering a resource version makes it available for use in CloudFormation templates in your AWS account , and includes: - Validating the resource schema. - Determining which handlers, if any, have been specified for the resource. - Making the resource available for use in your account. For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *CloudFormation User Guide* . You can have a maximum of 50 resource versions registered at a time. This maximum is per account and per Region.
Import
import { CfnResourceVersion } from 'aws-cdk-lib/aws-cloudformation';Or use the module namespace:
import * as cloudformation from 'aws-cdk-lib/aws-cloudformation';
// cloudformation.CfnResourceVersionProperties
Configuration passed to the constructor as CfnResourceVersionProps.
schemaHandlerPackageRequiredstringA URL to the S3 bucket for the resource project package that contains the necessary files for the resource you want to register. For information on generating a schema handler package, see [Modeling resource types to use with CloudFormation](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html) in the *CloudFormation Command Line Interface (CLI) User Guide* . > To register the resource version, you must have `s3:GetObject` permissions to access the S3 objects.
typeNameRequiredstringThe name of the resource being registered. We recommend that resource names adhere to the following pattern: *company_or_organization* :: *service* :: *type* . > The following organization namespaces are reserved and can't be used in your resource names: > > - `Alexa` > - `AMZN` > - `Amazon` > - `AWS` > - `Custom` > - `Dev`
executionRoleArnOptionalstringThe Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource. If your resource 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. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.
loggingConfigOptionalIResolvable | LoggingConfigPropertyLogging configuration information for a resource.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-cloudformationAWS::CloudFormation::ResourceVersion