Package software.amazon.awscdk.cfnpropertymixins.services.cloudformation

Class CfnResourceVersionPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.cloudformation.CfnResourceVersionPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnResourceVersionPropsMixin>

Enclosing class:

CfnResourceVersionPropsMixin

@Stability(Stable)
public static final class CfnResourceVersionPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnResourceVersionPropsMixin>

A fluent builder for CfnResourceVersionPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnResourceVersionPropsMixin	build()
static CfnResourceVersionPropsMixin.Builder	create()
static CfnResourceVersionPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnResourceVersionPropsMixin.Builder	executionRoleArn(String executionRoleArn)	The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource.
CfnResourceVersionPropsMixin.Builder	loggingConfig(CfnResourceVersionPropsMixin.LoggingConfigProperty loggingConfig)	Logging configuration information for a resource.
CfnResourceVersionPropsMixin.Builder	loggingConfig(IResolvable loggingConfig)	Logging configuration information for a resource.
CfnResourceVersionPropsMixin.Builder	schemaHandlerPackage(String schemaHandlerPackage)	A URL to the S3 bucket for the resource project package that contains the necessary files for the resource you want to register.
CfnResourceVersionPropsMixin.Builder	typeName(String typeName)	The name of the resource being registered.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnResourceVersionPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnResourceVersionPropsMixin.Builder.

create

@Stability(Stable)
public static CfnResourceVersionPropsMixin.Builder create()

Returns:

a new instance of CfnResourceVersionPropsMixin.Builder.

executionRoleArn

@Stability(Stable)
public CfnResourceVersionPropsMixin.Builder executionRoleArn(String executionRoleArn)

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.

Parameters:

executionRoleArn - The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource. This parameter is required.

Returns:

this

See Also:

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

loggingConfig

@Stability(Stable)
public CfnResourceVersionPropsMixin.Builder loggingConfig(IResolvable loggingConfig)

Logging configuration information for a resource.

Parameters:

loggingConfig - Logging configuration information for a resource. This parameter is required.

Returns:

this

See Also:

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

loggingConfig

@Stability(Stable)
public CfnResourceVersionPropsMixin.Builder loggingConfig(CfnResourceVersionPropsMixin.LoggingConfigProperty loggingConfig)

Logging configuration information for a resource.

Parameters:

loggingConfig - Logging configuration information for a resource. This parameter is required.

Returns:

this

See Also:

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

schemaHandlerPackage

@Stability(Stable)
public CfnResourceVersionPropsMixin.Builder schemaHandlerPackage(String schemaHandlerPackage)

A URL to the S3 bucket for 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 CloudFormation in the CloudFormation Command Line Interface (CLI) User Guide .

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

Parameters:

schemaHandlerPackage - A URL to the S3 bucket for the resource project package that contains the necessary files for the resource you want to register. This parameter is required.

Returns:

this

See Also:

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

typeName

@Stability(Stable)
public CfnResourceVersionPropsMixin.Builder typeName(String typeName)

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

Parameters:

typeName - The name of the resource being registered. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnResourceVersionPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnResourceVersionPropsMixin>

Returns:

a newly built instance of CfnResourceVersionPropsMixin.