Class: AWSCDK::CfnHookTypeConfigProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cfn_hook_type_config_props.rb

Overview

Properties for defining a CfnHookTypeConfig.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configuration:, configuration_alias: nil, type_arn: nil, type_name: nil) ⇒ CfnHookTypeConfigProps

Returns a new instance of CfnHookTypeConfigProps.

Parameters:

  • configuration (String) —

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

  • configuration_alias (String, nil) (defaults to: nil) —

    An alias by which to refer to this configuration data.

  • type_arn (String, nil) (defaults to: nil) —

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

  • type_name (String, nil) (defaults to: nil) —

    The unique name for your Hook.



13
14
15
16
17
18
19
20
21
22
 
# File 'cfn_hook_type_config_props.rb', line 13

def initialize(configuration:, configuration_alias: nil, type_arn: nil, type_name: nil)
  @configuration = configuration
  Jsii::Type.check_type(@configuration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "configuration")
  @configuration_alias = configuration_alias
  Jsii::Type.check_type(@configuration_alias, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "configurationAlias") unless @configuration_alias.nil?
  @type_arn = type_arn
  Jsii::Type.check_type(@type_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "typeArn") unless @type_arn.nil?
  @type_name = type_name
  Jsii::Type.check_type(@type_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "typeName") unless @type_name.nil?
end

Instance Attribute Details

#configuration ⇒ String (readonly)

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

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

Returns:

  • (String)

See Also:



30
31
32
 
# File 'cfn_hook_type_config_props.rb', line 30

def configuration
  @configuration
end

#configuration_alias ⇒ String? (readonly)

Note:

Default: - "default"

An alias by which to refer to this configuration data.

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

Returns:

  • (String, nil)

See Also:



38
39
40
 
# File 'cfn_hook_type_config_props.rb', line 38

def configuration_alias
  @configuration_alias
end

#type_arn ⇒ String? (readonly)

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

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

Returns:

  • (String, nil)

See Also:



45
46
47
 
# File 'cfn_hook_type_config_props.rb', line 45

def type_arn
  @type_arn
end

#type_name ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



54
55
56
 
# File 'cfn_hook_type_config_props.rb', line 54

def type_name
  @type_name
end

Class Method Details

.jsii_properties ⇒ Object 



56
57
58
59
60
61
62
63
 
# File 'cfn_hook_type_config_props.rb', line 56

def self.jsii_properties
  {
    :configuration => "configuration",
    :configuration_alias => "configurationAlias",
    :type_arn => "typeArn",
    :type_name => "typeName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



65
66
67
68
69
70
71
72
73
74
 
# File 'cfn_hook_type_config_props.rb', line 65

def to_jsii
  result = {}
  result.merge!({
    "configuration" => @configuration,
    "configurationAlias" => @configuration_alias,
    "typeArn" => @type_arn,
    "typeName" => @type_name,
  })
  result.compact
end