interface CfnResourceVersionProps
Language | Type name |
---|---|
![]() | Amazon.CDK.CfnResourceVersionProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2#CfnResourceVersionProps |
![]() | software.amazon.awscdk.CfnResourceVersionProps |
![]() | aws_cdk.CfnResourceVersionProps |
![]() | aws-cdk-lib » 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 cdk from 'aws-cdk-lib';
const cfnResourceVersionProps: cdk.CfnResourceVersionProps = {
schemaHandlerPackage: 'schemaHandlerPackage',
typeName: 'typeName',
// the properties below are optional
executionRoleArn: 'executionRoleArn',
loggingConfig: {
logGroupName: 'logGroupName',
logRoleArn: 'logRoleArn',
},
};
Properties
Name | Type | Description |
---|---|---|
schema | string | A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register. |
type | string | The name of the resource being registered. |
execution | string | The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource. |
logging | IResolvable | Logging | Logging 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, see Modeling resource types to use with AWS CloudFormation in the AWS CloudFormation Command Line Interface (CLI) User Guide .
To register the resource version, you must have
s3:GetObject
permissions to access the S3 objects.
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
|
Logging
(optional)
Logging configuration information for a resource.