1.204.0

class CfnResourceVersion (construct)

LanguageType name
.NETAmazon.CDK.AWS.CloudFormation.CfnResourceVersion
Javasoftware.amazon.awscdk.services.cloudformation.CfnResourceVersion
Pythonaws_cdk.aws_cloudformation.CfnResourceVersion
TypeScript @aws-cdk/aws-cloudformation » CfnResourceVersion

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::CloudFormation::ResourceVersion.

Registers a resource version with the CloudFormation service. 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 more information on how to develop resources and ready them for registration, see Creating Resource Providers in the CloudFormation CLI User Guide .

You can have a maximum of 50 resource versions registered at a time. This maximum is per account and per Region.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloudformation from '@aws-cdk/aws-cloudformation';
const cfnResourceVersion = new cloudformation.CfnResourceVersion(this, 'MyCfnResourceVersion', {
  schemaHandlerPackage: 'schemaHandlerPackage',
  typeName: 'typeName',

  // the properties below are optional
  executionRoleArn: 'executionRoleArn',
  loggingConfig: {
    logGroupName: 'logGroupName',
    logRoleArn: 'logRoleArn',
  },
});

Initializer

new CfnResourceVersion(scope: Construct, id: string, props: CfnResourceVersionProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnResourceVersionProps — - resource properties.

Create a new AWS::CloudFormation::ResourceVersion.

Construct Props

NameTypeDescription
schemaHandlerPackagestringA URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register.
typeNamestringThe name of the resource being registered.
executionRoleArn?stringThe Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource.
loggingConfig?IResolvable | LoggingConfigPropertyLogging configuration information for a resource.

schemaHandlerPackage

Type: string

A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register.

For information on generating a schema handler package for the resource you want to register, see submit in the CloudFormation CLI User Guide .

The user registering the resource must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide .

typeName

Type: string

The 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

executionRoleArn?

Type: string (optional)

The 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.

loggingConfig?

Type: IResolvable | LoggingConfigProperty (optional)

Logging configuration information for a resource.

Properties

NameTypeDescription
attrArnstringThe Amazon Resource Name (ARN) of the resource version.
attrIsDefaultVersionIResolvableWhether the resource version is set as the default version.
attrProvisioningTypestringThe provisioning behavior of the resource type.
attrTypeArnstringThe Amazon Resource Name (ARN) of the resource.
attrVersionIdstringThe ID of a specific version of the resource.
attrVisibilitystringThe scope at which the resource is visible and usable in CloudFormation operations.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeConstructNodeThe construct tree node associated with this construct.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
schemaHandlerPackagestringA URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register.
stackStackThe stack in which this element is defined.
typeNamestringThe name of the resource being registered.
executionRoleArn?stringThe Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource.
loggingConfig?IResolvable | LoggingConfigPropertyLogging configuration information for a resource.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrArn

Type: string

The Amazon Resource Name (ARN) of the resource version.

attrIsDefaultVersion

Type: IResolvable

Whether the resource version is set as the default version.

attrProvisioningType

Type: string

The provisioning behavior of the resource type.

CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE : The resource type includes an update handler to process updates to the type during stack update operations.

  • IMMUTABLE : The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE : The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.

  • create

  • read

  • delete

attrTypeArn

Type: string

The Amazon Resource Name (ARN) of the resource.

attrVersionId

Type: string

The ID of a specific version of the resource.

The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the resource version when it is registered.

attrVisibility

Type: string

The scope at which the resource is visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE : The resource is only visible and usable within the account in which it's registered. CloudFormation marks any resources you register as PRIVATE .
  • PUBLIC : The resource is publicly visible and usable within any Amazon account.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

schemaHandlerPackage

Type: string

A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register.

For information on generating a schema handler package for the resource you want to register, see submit in the CloudFormation CLI User Guide .

The user registering the resource must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide .

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

typeName

Type: string

The 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

executionRoleArn?

Type: string (optional)

The 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.

loggingConfig?

Type: IResolvable | LoggingConfigProperty (optional)

Logging configuration information for a resource.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

  • attributeName string — The name of the attribute.

Returns

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }
← PreviousNext →