Amazonka.CloudFormation.Types.ChangeSetHook

Documentation

data ChangeSetHook

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

See: newChangeSetHook smart constructor.

Constructors

ChangeSetHook'

Fields

• failureMode :: Maybe HookFailureMode

  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.
• invocationPoint :: Maybe HookInvocationPoint

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

• targetDetails :: Maybe ChangeSetHookTargetDetails

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

• typeConfigurationVersionId :: Maybe Text

  The version ID of the type configuration.

• typeName :: Maybe Text

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

  The following organization namespaces are reserved and can't be used in your hook type names:

  • Alexa

  • AMZN

  • Amazon

  • ASK

  • AWS

  • Custom

  • Dev

• typeVersionId :: Maybe Text

  The version ID of the type specified.

Instances

FromXML ChangeSetHook

Defined in Amazonka.CloudFormation.Types.ChangeSetHook

Methods

parseXML :: [Node] -> Either String ChangeSetHook

Generic ChangeSetHook

Defined in Amazonka.CloudFormation.Types.ChangeSetHook

Associated Types

type Rep ChangeSetHook :: Type -> Type

Methods

from :: ChangeSetHook -> Rep ChangeSetHook x

to :: Rep ChangeSetHook x -> ChangeSetHook

Read ChangeSetHook

Defined in Amazonka.CloudFormation.Types.ChangeSetHook

Methods

readsPrec :: Int -> ReadS ChangeSetHook

readList :: ReadS [ChangeSetHook]

readPrec :: ReadPrec ChangeSetHook

readListPrec :: ReadPrec [ChangeSetHook]

Show ChangeSetHook

Defined in Amazonka.CloudFormation.Types.ChangeSetHook

Methods

showsPrec :: Int -> ChangeSetHook -> ShowS

show :: ChangeSetHook -> String

showList :: [ChangeSetHook] -> ShowS

NFData ChangeSetHook

Defined in Amazonka.CloudFormation.Types.ChangeSetHook

Methods

rnf :: ChangeSetHook -> ()

Eq ChangeSetHook

Defined in Amazonka.CloudFormation.Types.ChangeSetHook

Methods

(==) :: ChangeSetHook -> ChangeSetHook -> Bool

(/=) :: ChangeSetHook -> ChangeSetHook -> Bool

Hashable ChangeSetHook

Defined in Amazonka.CloudFormation.Types.ChangeSetHook

Methods

hashWithSalt :: Int -> ChangeSetHook -> Int

hash :: ChangeSetHook -> Int

type Rep ChangeSetHook

Defined in Amazonka.CloudFormation.Types.ChangeSetHook

type Rep ChangeSetHook = D1 ('MetaData "ChangeSetHook" "Amazonka.CloudFormation.Types.ChangeSetHook" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ChangeSetHook'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failureMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HookFailureMode)) :*: (S1 ('MetaSel ('Just "invocationPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HookInvocationPoint)) :*: S1 ('MetaSel ('Just "targetDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChangeSetHookTargetDetails)))) :*: (S1 ('MetaSel ('Just "typeConfigurationVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "typeVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newChangeSetHook :: ChangeSetHook

Create a value of ChangeSetHook with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failureMode:ChangeSetHook', changeSetHook_failureMode - 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.

$sel:invocationPoint:ChangeSetHook', changeSetHook_invocationPoint - Specifies the points in provisioning logic where a hook is invoked.

$sel:targetDetails:ChangeSetHook', changeSetHook_targetDetails - Specifies details about the target that the hook will run against.

$sel:typeConfigurationVersionId:ChangeSetHook', changeSetHook_typeConfigurationVersionId - The version ID of the type configuration.

$sel:typeName:ChangeSetHook', changeSetHook_typeName - The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of Organization::Service::Hook.

The following organization namespaces are reserved and can't be used in your hook type names:

• Alexa

• AMZN

• Amazon

• ASK

• AWS

• Custom

• Dev

$sel:typeVersionId:ChangeSetHook', changeSetHook_typeVersionId - The version ID of the type specified.

changeSetHook_failureMode :: Lens' ChangeSetHook (Maybe HookFailureMode)

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.

changeSetHook_invocationPoint :: Lens' ChangeSetHook (Maybe HookInvocationPoint)

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

changeSetHook_targetDetails :: Lens' ChangeSetHook (Maybe ChangeSetHookTargetDetails)

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

changeSetHook_typeConfigurationVersionId :: Lens' ChangeSetHook (Maybe Text)

The version ID of the type configuration.

changeSetHook_typeName :: Lens' ChangeSetHook (Maybe Text)

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

The following organization namespaces are reserved and can't be used in your hook type names:

• Alexa

• AMZN

• Amazon

• ASK

• AWS

• Custom

• Dev

changeSetHook_typeVersionId :: Lens' ChangeSetHook (Maybe Text)

The version ID of the type specified.