1.204.0

interface CfnResourceVersionProps

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

Properties for defining a CfnResourceVersion.

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 cfnResourceVersionProps: cloudformation.CfnResourceVersionProps = {
  schemaHandlerPackage: 'schemaHandlerPackage',
  typeName: 'typeName',

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

Properties

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.

← PreviousNext →