software.amazon.awscdk

Class CfnHookTypeConfig

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

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:35.807Z")
 @Stability(value=Stable)
public class CfnHookTypeConfig
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudFormation::HookTypeConfig`.

The HookTypeConfig resource specifies the configuration of a hook.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 CfnHookTypeConfig cfnHookTypeConfig = CfnHookTypeConfig.Builder.create(this, "MyCfnHookTypeConfig")
         .configuration("configuration")
         // the properties below are optional
         .configurationAlias("configurationAlias")
         .typeArn("typeArn")
         .typeName("typeName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnHookTypeConfig.Builder A fluent builder for CfnHookTypeConfig.

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
	CfnHookTypeConfig(software.constructs.Construct scope, String id, CfnHookTypeConfigProps props) Create a new `AWS::CloudFormation::HookTypeConfig`.
protected	CfnHookTypeConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnHookTypeConfig(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrConfigurationArn() The Amazon Resource Number (ARN) of the activated hook type configuration, in this account and Region.
protected Map<String,Object>	getCfnProperties()
String	getConfiguration() Specifies the activated hook type configuration, in this AWS account and AWS Region .
String	getConfigurationAlias() Specifies the activated hook type configuration, in this AWS account and AWS Region .
String	getTypeArn() The Amazon Resource Number (ARN) for the hook to set `Configuration` for.
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	setConfiguration(String value) Specifies the activated hook type configuration, in this AWS account and AWS Region .
void	setConfigurationAlias(String value) Specifies the activated hook type configuration, in this AWS account and AWS Region .
void	setTypeArn(String value) The Amazon Resource Number (ARN) for the hook to set `Configuration` for.
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

CfnHookTypeConfig

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

CfnHookTypeConfig

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

CfnHookTypeConfig

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

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

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.

getAttrConfigurationArn

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

The Amazon Resource Number (ARN) of the activated hook type configuration, in this account and Region.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getConfiguration

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

Specifies the activated hook type configuration, in this AWS account and AWS Region .

You must specify either TypeName and Configuration or TypeARN and Configuration .

setConfiguration

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

Specifies the activated hook type configuration, in this AWS account and AWS Region .

You must specify either TypeName and Configuration or TypeARN and Configuration .

getConfigurationAlias

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

Specifies the activated hook type configuration, in this AWS account and AWS Region .

Defaults to default alias. Hook types currently support default configuration alias.

setConfigurationAlias

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

Specifies the activated hook type configuration, in this AWS account and AWS Region .

Defaults to default alias. Hook types currently support default configuration alias.

getTypeArn

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

The Amazon Resource Number (ARN) for the hook to set `Configuration` for.

You must specify either TypeName and Configuration or TypeARN and Configuration .

setTypeArn

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

The Amazon Resource Number (ARN) for the hook to set `Configuration` for.

You must specify either TypeName and Configuration or TypeARN and Configuration .

getTypeName

@Stability(value=Stable)
 @Nullable
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 .

You must specify either TypeName and Configuration or TypeARN and Configuration .

setTypeName

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

The unique name for your hook.

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

You must specify either TypeName and Configuration or TypeARN and Configuration .