Package software.amazon.awscdk.services.cloudformation

Class CfnResourceVersion.Builder

java.lang.Object

software.amazon.awscdk.services.cloudformation.CfnResourceVersion.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnResourceVersion>

Enclosing class:

CfnResourceVersion

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

A fluent builder for CfnResourceVersion.

Method Summary

Modifier and Type	Method	Description
CfnResourceVersion	build()
static CfnResourceVersion.Builder	create(software.constructs.Construct scope, String id)
CfnResourceVersion.Builder	executionRoleArn(String executionRoleArn)	The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource.
CfnResourceVersion.Builder	loggingConfig(IResolvable loggingConfig)	Logging configuration information for a resource.
CfnResourceVersion.Builder	loggingConfig(CfnResourceVersion.LoggingConfigProperty loggingConfig)	Logging configuration information for a resource.
CfnResourceVersion.Builder	schemaHandlerPackage(String schemaHandlerPackage)	A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register.
CfnResourceVersion.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 CfnResourceVersion.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnResourceVersion.Builder.

schemaHandlerPackage

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

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

Parameters:

schemaHandlerPackage - A URL to the S3 bucket containing 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 CfnResourceVersion.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

executionRoleArn

@Stability(Stable)
public CfnResourceVersion.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 CfnResourceVersion.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 CfnResourceVersion.Builder loggingConfig(CfnResourceVersion.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

build

@Stability(Stable)
public CfnResourceVersion build()

Specified by:

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

Returns:

a newly built instance of CfnResourceVersion.