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

Class CfnHookVersionPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnHookVersionPropsMixin>

Enclosing class:

CfnHookVersionPropsMixin

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

A fluent builder for CfnHookVersionPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnHookVersionPropsMixin	build()
static CfnHookVersionPropsMixin.Builder	create()
static CfnHookVersionPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnHookVersionPropsMixin.Builder	executionRoleArn(String executionRoleArn)	The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.
CfnHookVersionPropsMixin.Builder	loggingConfig(CfnHookVersionPropsMixin.LoggingConfigProperty loggingConfig)	Contains logging configuration information for an extension.
CfnHookVersionPropsMixin.Builder	loggingConfig(IResolvable loggingConfig)	Contains logging configuration information for an extension.
CfnHookVersionPropsMixin.Builder	schemaHandlerPackage(String schemaHandlerPackage)	A URL to the Amazon S3 bucket for the Hook project package that contains the necessary files for the Hook you want to register.
CfnHookVersionPropsMixin.Builder	typeName(String typeName)	The unique name for your Hook.

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 CfnHookVersionPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnHookVersionPropsMixin.Builder.

create

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

Returns:

a new instance of CfnHookVersionPropsMixin.Builder.

executionRoleArn

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

The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.

Parameters:

executionRoleArn - The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission. This parameter is required.

Returns:

this

See Also:

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

loggingConfig

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

Contains logging configuration information for an extension.

Parameters:

loggingConfig - Contains logging configuration information for an extension. This parameter is required.

Returns:

this

See Also:

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

loggingConfig

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

Contains logging configuration information for an extension.

Parameters:

loggingConfig - Contains logging configuration information for an extension. This parameter is required.

Returns:

this

See Also:

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

schemaHandlerPackage

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

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

For information on generating a schema handler package, see Modeling custom CloudFormation Hooks in the CloudFormation Hooks User Guide .

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

Parameters:

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

Returns:

this

See Also:

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

typeName

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

The unique name for your Hook.

Specifies a three-part namespace for your Hook, with a recommended pattern of Organization::Service::Hook .

The following organization namespaces are reserved and can't be used in your Hook type names:

• Alexa
• AMZN
• Amazon
• ASK
• AWS
• Custom
• Dev

Parameters:

typeName - The unique name for your Hook. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnHookVersionPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnHookVersionPropsMixin.