Class: Aws::CloudFormation::Types::ChangeSetHook

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

Specifies the resource, the hook, and the hook version to be invoked.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#failure_mode ⇒ String

Specify the hook failure mode for non-compliant resources in the followings ways.

  • `FAIL` Stops provisioning resources.

  • `WARN` Allows provisioning to continue with a warning message.

Returns:

  • (String) 

438
439
440
441
442
443
444
445
446
447
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 438

class ChangeSetHook < Struct.new(
  :invocation_point,
  :failure_mode,
  :type_name,
  :type_version_id,
  :type_configuration_version_id,
  :target_details)
  SENSITIVE = []
  include Aws::Structure
end

#invocation_point ⇒ String

Specifies the points in provisioning logic where a hook is invoked.

Returns:

  • (String) 

438
439
440
441
442
443
444
445
446
447
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 438

class ChangeSetHook < Struct.new(
  :invocation_point,
  :failure_mode,
  :type_name,
  :type_version_id,
  :type_configuration_version_id,
  :target_details)
  SENSITIVE = []
  include Aws::Structure
end

#target_details ⇒ Types::ChangeSetHookTargetDetails

Specifies details about the target that the hook will run against.

Returns:


438
439
440
441
442
443
444
445
446
447
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 438

class ChangeSetHook < Struct.new(
  :invocation_point,
  :failure_mode,
  :type_name,
  :type_version_id,
  :type_configuration_version_id,
  :target_details)
  SENSITIVE = []
  include Aws::Structure
end

#type_configuration_version_id ⇒ String

The version ID of the type configuration.

Returns:

  • (String) 

438
439
440
441
442
443
444
445
446
447
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 438

class ChangeSetHook < Struct.new(
  :invocation_point,
  :failure_mode,
  :type_name,
  :type_version_id,
  :type_configuration_version_id,
  :target_details)
  SENSITIVE = []
  include Aws::Structure
end

#type_name ⇒ String

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

<note markdown=“1”> The following organization namespaces are reserved and can't be used in your hook type names:

* `Alexa`

  • `AMZN`

  • `Amazon`

  • `ASK`

  • `AWS`

  • `Custom`

  • `Dev`

</note>

Returns:

  • (String) 

438
439
440
441
442
443
444
445
446
447
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 438

class ChangeSetHook < Struct.new(
  :invocation_point,
  :failure_mode,
  :type_name,
  :type_version_id,
  :type_configuration_version_id,
  :target_details)
  SENSITIVE = []
  include Aws::Structure
end

#type_version_id ⇒ String

The version ID of the type specified.

Returns:

  • (String) 

438
439
440
441
442
443
444
445
446
447
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 438

class ChangeSetHook < Struct.new(
  :invocation_point,
  :failure_mode,
  :type_name,
  :type_version_id,
  :type_configuration_version_id,
  :target_details)
  SENSITIVE = []
  include Aws::Structure
end