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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html

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

string? ExecutionRoleArn { get; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-executionrolearn

LoggingConfig

Logging configuration information for a resource.

object? LoggingConfig { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-loggingconfig

Type union: either IResolvable or CfnResourceVersion.ILoggingConfigProperty

SchemaHandlerPackage

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

string SchemaHandlerPackage { get; }

Property Value

string

Remarks

For information on generating a schema handler package, see Modeling resource types to use with CloudFormation in the CloudFormation Command Line Interface (CLI) User Guide .

To register the resource version, you must have <code>s3:GetObject</code> permissions to access the S3 objects.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-schemahandlerpackage

TypeName

The name of the resource being registered.

string TypeName { get; }

Property Value

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:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-typename