software.amazon.awscdk.services.cloudformation

Class CfnHookVersion

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.cloudformation.CfnHookVersion

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.995Z")
 @Stability(value=Stable)
public class CfnHookVersion
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudFormation::HookVersion`.

The HookVersion resource publishes new or first hook version to the AWS CloudFormation registry.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudformation.*;
 CfnHookVersion cfnHookVersion = CfnHookVersion.Builder.create(this, "MyCfnHookVersion")
         .schemaHandlerPackage("schemaHandlerPackage")
         .typeName("typeName")
         // the properties below are optional
         .executionRoleArn("executionRoleArn")
         .loggingConfig(LoggingConfigProperty.builder()
                 .logGroupName("logGroupName")
                 .logRoleArn("logRoleArn")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnHookVersion.Builder A fluent builder for CfnHookVersion.
static interface	CfnHookVersion.LoggingConfigProperty The `LoggingConfig` property type specifies logging configuration information for an extension.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnHookVersion(software.constructs.Construct scope, String id, CfnHookVersionProps props) Create a new `AWS::CloudFormation::HookVersion`.
protected	CfnHookVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnHookVersion(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the hook.
IResolvable	getAttrIsDefaultVersion() Whether the specified hook version is set as the default version.
String	getAttrTypeArn() The Amazon Resource Number (ARN) assigned to this version of the hook.
String	getAttrVersionId() The ID of this version of the hook.
String	getAttrVisibility() The scope at which the resource is visible and usable in CloudFormation operations.
protected Map<String,Object>	getCfnProperties()
String	getExecutionRoleArn() The Amazon Resource Name (ARN) of the task execution role that grants the hook permission.
Object	getLoggingConfig() Contains logging configuration information for an extension.
String	getSchemaHandlerPackage() A URL to the Amazon S3 bucket containing the hook project package that contains the necessary files for the hook you want to register.
String	getTypeName() The unique name for your hook.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setExecutionRoleArn(String value) The Amazon Resource Name (ARN) of the task execution role that grants the hook permission.
void	setLoggingConfig(CfnHookVersion.LoggingConfigProperty value) Contains logging configuration information for an extension.
void	setLoggingConfig(IResolvable value) Contains logging configuration information for an extension.
void	setSchemaHandlerPackage(String value) A URL to the Amazon S3 bucket containing the hook project package that contains the necessary files for the hook you want to register.
void	setTypeName(String value) The unique name for your hook.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnHookVersion

protected CfnHookVersion(software.amazon.jsii.JsiiObjectRef objRef)

CfnHookVersion

protected CfnHookVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnHookVersion

@Stability(value=Stable)
public CfnHookVersion(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnHookVersionProps props)

Create a new `AWS::CloudFormation::HookVersion`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the hook.

getAttrIsDefaultVersion

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrIsDefaultVersion()

Whether the specified hook version is set as the default version.

getAttrTypeArn

@Stability(value=Stable)
 @NotNull
public String getAttrTypeArn()

The Amazon Resource Number (ARN) assigned to this version of the hook.

getAttrVersionId

@Stability(value=Stable)
 @NotNull
public String getAttrVersionId()

The ID of this version of the hook.

getAttrVisibility

@Stability(value=Stable)
 @NotNull
public String getAttrVisibility()

The scope at which the resource is visible and usable in CloudFormation operations.

Valid values include:

• PRIVATE : The resource is only visible and usable within the account in which it's registered. CloudFormation marks any resources you register as PRIVATE .
• PUBLIC : The resource is publicly visible and usable within any Amazon account.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getSchemaHandlerPackage

@Stability(value=Stable)
 @NotNull
public String getSchemaHandlerPackage()

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 for the resource you want to register, see submit in the CloudFormation CLI User Guide for Extension Development .

The user registering the resource must be able to access the package in the S3 bucket. That's, the user must 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 .

setSchemaHandlerPackage

@Stability(value=Stable)
public void setSchemaHandlerPackage(@NotNull
                                                             String value)

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 for the resource you want to register, see submit in the CloudFormation CLI User Guide for Extension Development .

The user registering the resource must be able to access the package in the S3 bucket. That's, the user must 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 .

getTypeName

@Stability(value=Stable)
 @NotNull
public String getTypeName()

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

setTypeName

@Stability(value=Stable)
public void setTypeName(@NotNull
                                                 String value)

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

getExecutionRoleArn

@Stability(value=Stable)
 @Nullable
public String getExecutionRoleArn()

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

setExecutionRoleArn

@Stability(value=Stable)
public void setExecutionRoleArn(@Nullable
                                                         String value)

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

getLoggingConfig

@Stability(value=Stable)
 @Nullable
public Object getLoggingConfig()

Contains logging configuration information for an extension.

setLoggingConfig

@Stability(value=Stable)
public void setLoggingConfig(@Nullable
                                                      CfnHookVersion.LoggingConfigProperty value)

Contains logging configuration information for an extension.

setLoggingConfig

@Stability(value=Stable)
public void setLoggingConfig(@Nullable
                                                      IResolvable value)

Contains logging configuration information for an extension.