Skip to content
v2.277.0

CfnHookTypeConfigProps Struct ​

Properties for defining a CfnHookTypeConfig.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const cfnHookTypeConfigProps: cdk.CfnHookTypeConfigProps = {
  configuration: 'configuration',

  // the properties below are optional
  configurationAlias: 'configurationAlias',
  typeArn: 'typeArn',
  typeName: 'typeName',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

cfn_hook_type_config_props = cdk.CfnHookTypeConfigProps(
    configuration="configuration",

    # the properties below are optional
    configuration_alias="configurationAlias",
    type_arn="typeArn",
    type_name="typeName"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;

CfnHookTypeConfigProps cfnHookTypeConfigProps = CfnHookTypeConfigProps.builder()
        .configuration("configuration")

        // the properties below are optional
        .configurationAlias("configurationAlias")
        .typeArn("typeArn")
        .typeName("typeName")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;

var cfnHookTypeConfigProps = new CfnHookTypeConfigProps {
    Configuration = "configuration",

    // the properties below are optional
    ConfigurationAlias = "configurationAlias",
    TypeArn = "typeArn",
    TypeName = "typeName"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"

cfnHookTypeConfigProps := &CfnHookTypeConfigProps{
	Configuration: jsii.String("configuration"),

	// the properties below are optional
	ConfigurationAlias: jsii.String("configurationAlias"),
	TypeArn: jsii.String("typeArn"),
	TypeName: jsii.String("typeName"),
}

Properties ​

configurationstringconfigurationstrconfigurationStringConfigurationstringConfiguration*string required #
Specifies the activated Hook type configuration, in this AWS account and AWS Region .

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

configurationAliasoptionalstringconfiguration_aliasoptionalstrconfigurationAliasoptionalStringConfigurationAliasoptionalstringConfigurationAliasoptional*string = "default" #
An alias by which to refer to this configuration data.

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

typeArnoptionalstringtype_arnoptionalstrtypeArnoptionalStringTypeArnoptionalstringTypeArnoptional*string #
The Amazon Resource Number (ARN) for the Hook to set `Configuration` for.

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

typeNameoptionalstringtype_nameoptionalstrtypeNameoptionalStringTypeNameoptionalstringTypeNameoptional*string #
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 .