Class CfnResourceVersionProps

Properties for defining a CfnResourceVersion.

Inheritance
System.Object
CfnResourceVersionProps
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnResourceVersionProps : Object, ICfnResourceVersionProps
Syntax (vb)
Public Class CfnResourceVersionProps
    Inherits Object
    Implements 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

Constructors

CfnResourceVersionProps()

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.

Constructors

CfnResourceVersionProps()

public CfnResourceVersionProps()

Properties

ExecutionRoleArn

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource.

public string ExecutionRoleArn { get; set; }
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.

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.

public object LoggingConfig { get; set; }
Property Value

System.Object

Remarks

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

SchemaHandlerPackage

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

public string SchemaHandlerPackage { get; set; }
Property Value

System.String

Remarks

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.

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.

public string TypeName { get; set; }
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:

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

    Implements