Interface ICfnResourceVersionProps
Properties for defining a CfnResourceVersion
.
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnResourceVersionProps
Syntax (vb)
Public Interface ICfnResourceVersionProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
var cfnResourceVersionProps = new CfnResourceVersionProps {
SchemaHandlerPackage = "schemaHandlerPackage",
TypeName = "typeName",
// the properties below are optional
ExecutionRoleArn = "executionRoleArn",
LoggingConfig = new LoggingConfigProperty {
LogGroupName = "logGroupName",
LogRoleArn = "logRoleArn"
}
};
Synopsis
Properties
ExecutionRoleArn | The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource. |
LoggingConfig | Logging configuration information for a resource. |
SchemaHandlerPackage | A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register. |
TypeName | The name of the resource being registered. |
Properties
ExecutionRoleArn
The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource.
virtual string ExecutionRoleArn { get; }
Property Value
System.String
Remarks
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
Logging configuration information for a resource.
virtual object LoggingConfig { get; }
Property Value
System.Object
Remarks
SchemaHandlerPackage
A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register.
string SchemaHandlerPackage { get; }
Property Value
System.String
Remarks
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
The name of the resource being registered.
string TypeName { get; }
Property Value
System.String
Remarks
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: