CloudFormationHookInvocationProgress

class aws_cdk.mixins_preview.aws_cloudformation.events.CloudFormationHookInvocationProgress

Bases: object

(experimental) EventBridge event pattern for aws.cloudformation@CloudFormationHookInvocationProgress.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudformation import events as cloudformation_events

cloud_formation_hook_invocation_progress = cloudformation_events.CloudFormationHookInvocationProgress()

Stability:: experimental

Static Methods

classmethod cloud_formation_hook_invocation_progress_pattern(*, event_metadata=None, hook_detail=None, result=None, status=None, status_reason=None, target_detail=None)

(experimental) EventBridge event pattern for CloudFormation Hook Invocation Progress.

Parameters:

event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
hook_detail (Union[HookDetail, Dict[str, Any], None]) – (experimental) hook-detail property. Specify an array of string values to match this event if the actual value of hook-detail is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
result (Union[Result, Dict[str, Any], None]) – (experimental) result property. Specify an array of string values to match this event if the actual value of result is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
status (Optional[Sequence[str]]) – (experimental) status property. Specify an array of string values to match this event if the actual value of status is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
status_reason (Optional[Sequence[str]]) – (experimental) status-reason property. Specify an array of string values to match this event if the actual value of status-reason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
target_detail (Union[TargetDetail, Dict[str, Any], None]) – (experimental) target-detail property. Specify an array of string values to match this event if the actual value of target-detail is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

CloudFormationHookInvocationProgressProps

class CloudFormationHookInvocationProgress.CloudFormationHookInvocationProgressProps(*, event_metadata=None, hook_detail=None, result=None, status=None, status_reason=None, target_detail=None)

Bases: object

(experimental) Props type for aws.cloudformation@CloudFormationHookInvocationProgress event.

Parameters:

event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
hook_detail (Union[HookDetail, Dict[str, Any], None]) – (experimental) hook-detail property. Specify an array of string values to match this event if the actual value of hook-detail is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
result (Union[Result, Dict[str, Any], None]) – (experimental) result property. Specify an array of string values to match this event if the actual value of result is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
status (Optional[Sequence[str]]) – (experimental) status property. Specify an array of string values to match this event if the actual value of status is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
status_reason (Optional[Sequence[str]]) – (experimental) status-reason property. Specify an array of string values to match this event if the actual value of status-reason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
target_detail (Union[TargetDetail, Dict[str, Any], None]) – (experimental) target-detail property. Specify an array of string values to match this event if the actual value of target-detail is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import AWSEventMetadataProps
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudformation import events as cloudformation_events

cloud_formation_hook_invocation_progress_props = cloudformation_events.CloudFormationHookInvocationProgress.CloudFormationHookInvocationProgressProps(
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    hook_detail=cloudformation_events.CloudFormationHookInvocationProgress.HookDetail(
        description=["description"],
        documentation_url=["documentationUrl"],
        failure_mode=["failureMode"],
        hook_type_arn=["hookTypeArn"],
        hook_type_name=["hookTypeName"],
        hook_version=["hookVersion"],
        source_url=["sourceUrl"]
    ),
    result=cloudformation_events.CloudFormationHookInvocationProgress.Result(
        data=["data"]
    ),
    status=["status"],
    status_reason=["statusReason"],
    target_detail=cloudformation_events.CloudFormationHookInvocationProgress.TargetDetail(
        target_action=["targetAction"],
        target_id=["targetId"],
        target_invocation_point=["targetInvocationPoint"],
        target_name=["targetName"],
        target_type=["targetType"]
    )
)

Attributes

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

hook_detail

(experimental) hook-detail property.

Specify an array of string values to match this event if the actual value of hook-detail is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

result

(experimental) result property.

Specify an array of string values to match this event if the actual value of result is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

status

(experimental) status property.

Specify an array of string values to match this event if the actual value of status is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

status_reason

(experimental) status-reason property.

Specify an array of string values to match this event if the actual value of status-reason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

target_detail

(experimental) target-detail property.

Specify an array of string values to match this event if the actual value of target-detail is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

HookDetail

class CloudFormationHookInvocationProgress.HookDetail(*, description=None, documentation_url=None, failure_mode=None, hook_type_arn=None, hook_type_name=None, hook_version=None, source_url=None)

Bases: object

(experimental) Type definition for Hook-detail.

Parameters:

description (Optional[Sequence[str]]) – (experimental) description property. Specify an array of string values to match this event if the actual value of description is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
documentation_url (Optional[Sequence[str]]) – (experimental) documentation-url property. Specify an array of string values to match this event if the actual value of documentation-url is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
failure_mode (Optional[Sequence[str]]) – (experimental) failure-mode property. Specify an array of string values to match this event if the actual value of failure-mode is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
hook_type_arn (Optional[Sequence[str]]) – (experimental) hook-type-arn property. Specify an array of string values to match this event if the actual value of hook-type-arn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
hook_type_name (Optional[Sequence[str]]) – (experimental) hook-type-name property. Specify an array of string values to match this event if the actual value of hook-type-name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
hook_version (Optional[Sequence[str]]) – (experimental) hook-version property. Specify an array of string values to match this event if the actual value of hook-version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_url (Optional[Sequence[str]]) – (experimental) source-url property. Specify an array of string values to match this event if the actual value of source-url is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudformation import events as cloudformation_events

hook_detail = cloudformation_events.CloudFormationHookInvocationProgress.HookDetail(
    description=["description"],
    documentation_url=["documentationUrl"],
    failure_mode=["failureMode"],
    hook_type_arn=["hookTypeArn"],
    hook_type_name=["hookTypeName"],
    hook_version=["hookVersion"],
    source_url=["sourceUrl"]
)

Attributes

description

(experimental) description property.

Specify an array of string values to match this event if the actual value of description is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

documentation_url

(experimental) documentation-url property.

Specify an array of string values to match this event if the actual value of documentation-url is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

failure_mode

(experimental) failure-mode property.

Specify an array of string values to match this event if the actual value of failure-mode is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

hook_type_arn

(experimental) hook-type-arn property.

Specify an array of string values to match this event if the actual value of hook-type-arn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

hook_type_name

(experimental) hook-type-name property.

Specify an array of string values to match this event if the actual value of hook-type-name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

hook_version

(experimental) hook-version property.

Specify an array of string values to match this event if the actual value of hook-version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

source_url

(experimental) source-url property.

Specify an array of string values to match this event if the actual value of source-url is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

Result

class CloudFormationHookInvocationProgress.Result(*, data=None)

Bases: object

(experimental) Type definition for Result.

Parameters:: data (Optional[Sequence[str]]) – (experimental) data property. Specify an array of string values to match this event if the actual value of data is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudformation import events as cloudformation_events

result = cloudformation_events.CloudFormationHookInvocationProgress.Result(
    data=["data"]
)

Attributes

data

(experimental) data property.

Specify an array of string values to match this event if the actual value of data is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

TargetDetail

class CloudFormationHookInvocationProgress.TargetDetail(*, target_action=None, target_id=None, target_invocation_point=None, target_name=None, target_type=None)

Bases: object

(experimental) Type definition for Target-detail.

Parameters:

target_action (Optional[Sequence[str]]) – (experimental) target-action property. Specify an array of string values to match this event if the actual value of target-action is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
target_id (Optional[Sequence[str]]) – (experimental) target-id property. Specify an array of string values to match this event if the actual value of target-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
target_invocation_point (Optional[Sequence[str]]) – (experimental) target-invocation-point property. Specify an array of string values to match this event if the actual value of target-invocation-point is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
target_name (Optional[Sequence[str]]) – (experimental) target-name property. Specify an array of string values to match this event if the actual value of target-name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
target_type (Optional[Sequence[str]]) – (experimental) target-type property. Specify an array of string values to match this event if the actual value of target-type is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudformation import events as cloudformation_events

target_detail = cloudformation_events.CloudFormationHookInvocationProgress.TargetDetail(
    target_action=["targetAction"],
    target_id=["targetId"],
    target_invocation_point=["targetInvocationPoint"],
    target_name=["targetName"],
    target_type=["targetType"]
)

Attributes

target_action

(experimental) target-action property.

Specify an array of string values to match this event if the actual value of target-action is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

target_id

(experimental) target-id property.

Specify an array of string values to match this event if the actual value of target-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

target_invocation_point

(experimental) target-invocation-point property.

Specify an array of string values to match this event if the actual value of target-invocation-point is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

target_name

(experimental) target-name property.

Specify an array of string values to match this event if the actual value of target-name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

target_type

(experimental) target-type property.

Specify an array of string values to match this event if the actual value of target-type is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental