ClusterEvents

class aws_cdk.mixins_preview.aws_ecs.events.ClusterEvents(*args: Any, **kwargs)

Bases: object

(experimental) EventBridge event patterns for Cluster.

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_ecs import events as ecs_events
from aws_cdk.interfaces import aws_ecs as interfaces_ecs

# cluster_ref: interfaces_ecs.IClusterRef

cluster_events = ecs_events.ClusterEvents.from_cluster(cluster_ref)

Methods

aws_api_call_via_cloud_trail_pattern(*, aws_region=None, event_id=None, event_metadata=None, event_name=None, event_source=None, event_time=None, event_type=None, event_version=None, request_id=None, request_parameters=None, response_elements=None, source_ip_address=None, user_agent=None, user_identity=None)

(experimental) EventBridge event pattern for Cluster AWS API Call via CloudTrail.

Parameters:

aws_region (Optional[Sequence[str]]) – (experimental) awsRegion property. Specify an array of string values to match this event if the actual value of awsRegion 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
event_id (Optional[Sequence[str]]) – (experimental) eventID property. Specify an array of string values to match this event if the actual value of eventID 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
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
event_name (Optional[Sequence[str]]) – (experimental) eventName property. Specify an array of string values to match this event if the actual value of eventName 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
event_source (Optional[Sequence[str]]) – (experimental) eventSource property. Specify an array of string values to match this event if the actual value of eventSource 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
event_time (Optional[Sequence[str]]) – (experimental) eventTime property. Specify an array of string values to match this event if the actual value of eventTime 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
event_type (Optional[Sequence[str]]) – (experimental) eventType property. Specify an array of string values to match this event if the actual value of eventType 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
event_version (Optional[Sequence[str]]) – (experimental) eventVersion property. Specify an array of string values to match this event if the actual value of eventVersion 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
request_id (Optional[Sequence[str]]) – (experimental) requestID property. Specify an array of string values to match this event if the actual value of requestID 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
request_parameters (Union[RequestParameters, Dict[str, Any], None]) – (experimental) requestParameters property. Specify an array of string values to match this event if the actual value of requestParameters 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
response_elements (Union[ResponseElements, Dict[str, Any], None]) – (experimental) responseElements property. Specify an array of string values to match this event if the actual value of responseElements 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_ip_address (Optional[Sequence[str]]) – (experimental) sourceIPAddress property. Specify an array of string values to match this event if the actual value of sourceIPAddress 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
user_agent (Optional[Sequence[str]]) – (experimental) userAgent property. Specify an array of string values to match this event if the actual value of userAgent 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
user_identity (Union[UserIdentity, Dict[str, Any], None]) – (experimental) userIdentity property. Specify an array of string values to match this event if the actual value of userIdentity 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

ecs_container_instance_state_change_pattern(*, account_type=None, agent_connected=None, agent_update_status=None, attachments=None, attributes=None, cluster_arn=None, container_instance_arn=None, ec2_instance_id=None, event_metadata=None, pending_tasks_count=None, registered_at=None, registered_resources=None, remaining_resources=None, running_tasks_count=None, status=None, status_reason=None, updated_at=None, version=None, version_info=None)

(experimental) EventBridge event pattern for Cluster ECS Container Instance State Change.

Parameters:

account_type (Optional[Sequence[str]]) – (experimental) accountType property. Specify an array of string values to match this event if the actual value of accountType 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
agent_connected (Optional[Sequence[str]]) – (experimental) agentConnected property. Specify an array of string values to match this event if the actual value of agentConnected 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
agent_update_status (Optional[Sequence[str]]) – (experimental) agentUpdateStatus property. Specify an array of string values to match this event if the actual value of agentUpdateStatus 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
attachments (Optional[Sequence[Union[AttachmentDetails, Dict[str, Any]]]]) – (experimental) attachments property. Specify an array of string values to match this event if the actual value of attachments 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
attributes (Optional[Sequence[Union[AttributesDetails, Dict[str, Any]]]]) – (experimental) attributes property. Specify an array of string values to match this event if the actual value of attributes 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
cluster_arn (Optional[Sequence[str]]) – (experimental) clusterArn property. Specify an array of string values to match this event if the actual value of clusterArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Cluster reference
container_instance_arn (Optional[Sequence[str]]) – (experimental) containerInstanceArn property. Specify an array of string values to match this event if the actual value of containerInstanceArn 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
ec2_instance_id (Optional[Sequence[str]]) – (experimental) ec2InstanceId property. Specify an array of string values to match this event if the actual value of ec2InstanceId 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
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
pending_tasks_count (Optional[Sequence[str]]) – (experimental) pendingTasksCount property. Specify an array of string values to match this event if the actual value of pendingTasksCount 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
registered_at (Optional[Sequence[str]]) – (experimental) registeredAt property. Specify an array of string values to match this event if the actual value of registeredAt 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
registered_resources (Optional[Sequence[Union[ResourceDetails, Dict[str, Any]]]]) – (experimental) registeredResources property. Specify an array of string values to match this event if the actual value of registeredResources 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
remaining_resources (Optional[Sequence[Union[ResourceDetails, Dict[str, Any]]]]) – (experimental) remainingResources property. Specify an array of string values to match this event if the actual value of remainingResources 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
running_tasks_count (Optional[Sequence[str]]) – (experimental) runningTasksCount property. Specify an array of string values to match this event if the actual value of runningTasksCount 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) statusReason property. Specify an array of string values to match this event if the actual value of statusReason 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
updated_at (Optional[Sequence[str]]) – (experimental) updatedAt property. Specify an array of string values to match this event if the actual value of updatedAt 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
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of 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
version_info (Union[VersionInfo, Dict[str, Any], None]) – (experimental) versionInfo property. Specify an array of string values to match this event if the actual value of versionInfo 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

ecs_service_action_pattern(*, capacity_provider_arns=None, cluster_arn=None, container_instance_arns=None, container_port=None, created_at=None, desired_count=None, ec2_instance_ids=None, event_metadata=None, event_name=None, event_type=None, reason=None, service_registry_arns=None, target_group_arns=None, targets=None, task_arns=None, task_set_arns=None)

(experimental) EventBridge event pattern for Cluster ECS Service Action.

Parameters:

capacity_provider_arns (Optional[Sequence[str]]) – (experimental) capacityProviderArns property. Specify an array of string values to match this event if the actual value of capacityProviderArns 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
cluster_arn (Optional[Sequence[str]]) – (experimental) clusterArn property. Specify an array of string values to match this event if the actual value of clusterArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Cluster reference
container_instance_arns (Optional[Sequence[str]]) – (experimental) containerInstanceArns property. Specify an array of string values to match this event if the actual value of containerInstanceArns 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
container_port (Optional[Sequence[str]]) – (experimental) containerPort property. Specify an array of string values to match this event if the actual value of containerPort 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
created_at (Optional[Sequence[str]]) – (experimental) createdAt property. Specify an array of string values to match this event if the actual value of createdAt 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
desired_count (Optional[Sequence[str]]) – (experimental) desiredCount property. Specify an array of string values to match this event if the actual value of desiredCount 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
ec2_instance_ids (Optional[Sequence[str]]) – (experimental) ec2InstanceIds property. Specify an array of string values to match this event if the actual value of ec2InstanceIds 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
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
event_name (Optional[Sequence[str]]) – (experimental) eventName property. Specify an array of string values to match this event if the actual value of eventName 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
event_type (Optional[Sequence[str]]) – (experimental) eventType property. Specify an array of string values to match this event if the actual value of eventType 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
reason (Optional[Sequence[str]]) – (experimental) reason property. Specify an array of string values to match this event if the actual value of 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
service_registry_arns (Optional[Sequence[str]]) – (experimental) serviceRegistryArns property. Specify an array of string values to match this event if the actual value of serviceRegistryArns 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_group_arns (Optional[Sequence[str]]) – (experimental) targetGroupArns property. Specify an array of string values to match this event if the actual value of targetGroupArns 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
targets (Optional[Sequence[str]]) – (experimental) targets property. Specify an array of string values to match this event if the actual value of targets 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
task_arns (Optional[Sequence[str]]) – (experimental) taskArns property. Specify an array of string values to match this event if the actual value of taskArns 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
task_set_arns (Optional[Sequence[str]]) – (experimental) taskSetArns property. Specify an array of string values to match this event if the actual value of taskSetArns 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

ecs_task_state_change_pattern(*, attachments=None, attributes=None, availability_zone=None, cluster_arn=None, connectivity=None, connectivity_at=None, container_instance_arn=None, containers=None, cpu=None, created_at=None, desired_status=None, event_metadata=None, execution_stopped_at=None, group=None, last_status=None, launch_type=None, memory=None, overrides=None, platform_version=None, pull_started_at=None, pull_stopped_at=None, started_at=None, started_by=None, stop_code=None, stopped_at=None, stopped_reason=None, stopping_at=None, task_arn=None, task_definition_arn=None, updated_at=None, version=None)

(experimental) EventBridge event pattern for Cluster ECS Task State Change.

Parameters:

attachments (Optional[Sequence[Union[AttachmentDetails, Dict[str, Any]]]]) – (experimental) attachments property. Specify an array of string values to match this event if the actual value of attachments 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
attributes (Optional[Sequence[Union[AttributesDetails, Dict[str, Any]]]]) – (experimental) attributes property. Specify an array of string values to match this event if the actual value of attributes 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
availability_zone (Optional[Sequence[str]]) – (experimental) availabilityZone property. Specify an array of string values to match this event if the actual value of availabilityZone 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
cluster_arn (Optional[Sequence[str]]) – (experimental) clusterArn property. Specify an array of string values to match this event if the actual value of clusterArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Cluster reference
connectivity (Optional[Sequence[str]]) – (experimental) connectivity property. Specify an array of string values to match this event if the actual value of connectivity 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
connectivity_at (Optional[Sequence[str]]) – (experimental) connectivityAt property. Specify an array of string values to match this event if the actual value of connectivityAt 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
container_instance_arn (Optional[Sequence[str]]) – (experimental) containerInstanceArn property. Specify an array of string values to match this event if the actual value of containerInstanceArn 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
containers (Optional[Sequence[Union[ContainerDetails, Dict[str, Any]]]]) – (experimental) containers property. Specify an array of string values to match this event if the actual value of containers 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
cpu (Optional[Sequence[str]]) – (experimental) cpu property. Specify an array of string values to match this event if the actual value of cpu 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
created_at (Optional[Sequence[str]]) – (experimental) createdAt property. Specify an array of string values to match this event if the actual value of createdAt 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
desired_status (Optional[Sequence[str]]) – (experimental) desiredStatus property. Specify an array of string values to match this event if the actual value of desiredStatus 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
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
execution_stopped_at (Optional[Sequence[str]]) – (experimental) executionStoppedAt property. Specify an array of string values to match this event if the actual value of executionStoppedAt 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
group (Optional[Sequence[str]]) – (experimental) group property. Specify an array of string values to match this event if the actual value of group 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
last_status (Optional[Sequence[str]]) – (experimental) lastStatus property. Specify an array of string values to match this event if the actual value of lastStatus 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
launch_type (Optional[Sequence[str]]) – (experimental) launchType property. Specify an array of string values to match this event if the actual value of launchType 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
memory (Optional[Sequence[str]]) – (experimental) memory property. Specify an array of string values to match this event if the actual value of memory 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
overrides (Union[Overrides, Dict[str, Any], None]) – (experimental) overrides property. Specify an array of string values to match this event if the actual value of overrides 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
platform_version (Optional[Sequence[str]]) – (experimental) platformVersion property. Specify an array of string values to match this event if the actual value of platformVersion 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
pull_started_at (Optional[Sequence[str]]) – (experimental) pullStartedAt property. Specify an array of string values to match this event if the actual value of pullStartedAt 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
pull_stopped_at (Optional[Sequence[str]]) – (experimental) pullStoppedAt property. Specify an array of string values to match this event if the actual value of pullStoppedAt 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
started_at (Optional[Sequence[str]]) – (experimental) startedAt property. Specify an array of string values to match this event if the actual value of startedAt 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
started_by (Optional[Sequence[str]]) – (experimental) startedBy property. Specify an array of string values to match this event if the actual value of startedBy 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
stop_code (Optional[Sequence[str]]) – (experimental) stopCode property. Specify an array of string values to match this event if the actual value of stopCode 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
stopped_at (Optional[Sequence[str]]) – (experimental) stoppedAt property. Specify an array of string values to match this event if the actual value of stoppedAt 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
stopped_reason (Optional[Sequence[str]]) – (experimental) stoppedReason property. Specify an array of string values to match this event if the actual value of stoppedReason 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
stopping_at (Optional[Sequence[str]]) – (experimental) stoppingAt property. Specify an array of string values to match this event if the actual value of stoppingAt 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
task_arn (Optional[Sequence[str]]) – (experimental) taskArn property. Specify an array of string values to match this event if the actual value of taskArn 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
task_definition_arn (Optional[Sequence[str]]) – (experimental) taskDefinitionArn property. Specify an array of string values to match this event if the actual value of taskDefinitionArn 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
updated_at (Optional[Sequence[str]]) – (experimental) updatedAt property. Specify an array of string values to match this event if the actual value of updatedAt 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
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of 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

Return type:

EventPattern

Static Methods

classmethod from_cluster(cluster_ref)

(experimental) Create ClusterEvents from a Cluster reference.

Parameters:: cluster_ref (IClusterRef)
Stability:: experimental
Return type:: ClusterEvents