Interface ICfnHookTypeConfigProps

Properties for defining a CfnHookTypeConfig.

Namespace: Amazon.CDK.AWS.CloudFormation

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnHookTypeConfigProps

Syntax (vb)

Public Interface ICfnHookTypeConfigProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CloudFormation;

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

                 // the properties below are optional
                 ConfigurationAlias = "configurationAlias",
                 TypeArn = "typeArn",
                 TypeName = "typeName"
             };

Synopsis

Properties

Configuration	Specifies the activated Hook type configuration, in this AWS account and AWS Region .
ConfigurationAlias	An alias by which to refer to this configuration data.
TypeArn	The Amazon Resource Number (ARN) for the Hook to set Configuration for.
TypeName	The unique name for your Hook.

Properties

Configuration

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

string Configuration { get; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configuration

ConfigurationAlias

An alias by which to refer to this configuration data.

string? ConfigurationAlias { get; }

Property Value

string

Remarks

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

Default: - "default"

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configurationalias

TypeArn

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

string? TypeArn { get; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typearn

TypeName

The unique name for your Hook.

string? TypeName { get; }

Property Value

string

Remarks

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 .

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