Package software.amazon.awscdk.services.cloudformation

Class CfnHookVersion.Builder

java.lang.Object

software.amazon.awscdk.services.cloudformation.CfnHookVersion.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnHookVersion>

Enclosing class:

CfnHookVersion

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

A fluent builder for CfnHookVersion.

Method Summary

Modifier and Type	Method	Description
CfnHookVersion	build()
static CfnHookVersion.Builder	create(software.constructs.Construct scope, String id)
CfnHookVersion.Builder	executionRoleArn(String executionRoleArn)	The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.
CfnHookVersion.Builder	loggingConfig(IResolvable loggingConfig)	Contains logging configuration information for an extension.
CfnHookVersion.Builder	loggingConfig(CfnHookVersion.LoggingConfigProperty loggingConfig)	Contains logging configuration information for an extension.
CfnHookVersion.Builder	schemaHandlerPackage(String schemaHandlerPackage)	A URL to the Amazon S3 bucket containing the Hook project package that contains the necessary files for the Hook you want to register.
CfnHookVersion.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 CfnHookVersion.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 CfnHookVersion.Builder.

schemaHandlerPackage

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

A URL to the Amazon S3 bucket containing 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 AWS 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 containing 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 CfnHookVersion.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

executionRoleArn

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

build

@Stability(Stable)
public CfnHookVersion build()

Specified by:

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

Returns:

a newly built instance of CfnHookVersion.