WorkGroupEvents

class aws_cdk.mixins_preview.aws_athena.events.WorkGroupEvents(*args: Any, **kwargs)

Bases: object

(experimental) EventBridge event patterns for WorkGroup.

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_athena import events as athena_events
from aws_cdk.interfaces import aws_athena as interfaces_aws_athena

# work_group_ref: interfaces_aws_athena.IWorkGroupRef

work_group_events = athena_events.WorkGroupEvents.from_work_group(work_group_ref)

Methods

athena_query_state_change_pattern(*, current_state=None, event_metadata=None, previous_state=None, query_execution_id=None, sequence_number=None, statement_type=None, version_id=None, workgroup_name=None)

(experimental) EventBridge event pattern for WorkGroup Athena Query State Change.

Parameters:

current_state (Optional[Sequence[str]]) – (experimental) currentState property. Specify an array of string values to match this event if the actual value of currentState 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: - -
previous_state (Optional[Sequence[str]]) – (experimental) previousState property. Specify an array of string values to match this event if the actual value of previousState 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
query_execution_id (Optional[Sequence[str]]) – (experimental) queryExecutionId property. Specify an array of string values to match this event if the actual value of queryExecutionId 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
sequence_number (Optional[Sequence[str]]) – (experimental) sequenceNumber property. Specify an array of string values to match this event if the actual value of sequenceNumber 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
statement_type (Optional[Sequence[str]]) – (experimental) statementType property. Specify an array of string values to match this event if the actual value of statementType 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_id (Optional[Sequence[str]]) – (experimental) versionId property. Specify an array of string values to match this event if the actual value of versionId 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
workgroup_name (Optional[Sequence[str]]) – (experimental) workgroupName property. Specify an array of string values to match this event if the actual value of workgroupName 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 WorkGroup reference

Stability:

experimental

Return type:

EventPattern

Static Methods

classmethod from_work_group(work_group_ref)

(experimental) Create WorkGroupEvents from a WorkGroup reference.

Parameters:: work_group_ref (IWorkGroupRef)
Stability:: experimental
Return type:: WorkGroupEvents

AthenaQueryStateChange

class WorkGroupEvents.AthenaQueryStateChange

Bases: object

(experimental) aws.athena@AthenaQueryStateChange event types for WorkGroup.

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_athena import events as athena_events

athena_query_state_change = athena_events.WorkGroupEvents.AthenaQueryStateChange()

Stability:: experimental

AthenaQueryStateChangeProps

class WorkGroupEvents.AthenaQueryStateChange.AthenaQueryStateChangeProps(*, current_state=None, event_metadata=None, previous_state=None, query_execution_id=None, sequence_number=None, statement_type=None, version_id=None, workgroup_name=None)

Bases: object

(experimental) Props type for WorkGroup aws.athena@AthenaQueryStateChange event.

Parameters:

current_state (Optional[Sequence[str]]) – (experimental) currentState property. Specify an array of string values to match this event if the actual value of currentState 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: - -
previous_state (Optional[Sequence[str]]) – (experimental) previousState property. Specify an array of string values to match this event if the actual value of previousState 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
query_execution_id (Optional[Sequence[str]]) – (experimental) queryExecutionId property. Specify an array of string values to match this event if the actual value of queryExecutionId 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
sequence_number (Optional[Sequence[str]]) – (experimental) sequenceNumber property. Specify an array of string values to match this event if the actual value of sequenceNumber 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
statement_type (Optional[Sequence[str]]) – (experimental) statementType property. Specify an array of string values to match this event if the actual value of statementType 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_id (Optional[Sequence[str]]) – (experimental) versionId property. Specify an array of string values to match this event if the actual value of versionId 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
workgroup_name (Optional[Sequence[str]]) – (experimental) workgroupName property. Specify an array of string values to match this event if the actual value of workgroupName 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 WorkGroup reference

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_athena import events as athena_events

athena_query_state_change_props = athena_events.WorkGroupEvents.AthenaQueryStateChange.AthenaQueryStateChangeProps(
    current_state=["currentState"],
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    previous_state=["previousState"],
    query_execution_id=["queryExecutionId"],
    sequence_number=["sequenceNumber"],
    statement_type=["statementType"],
    version_id=["versionId"],
    workgroup_name=["workgroupName"]
)

Attributes

current_state

(experimental) currentState property.

Specify an array of string values to match this event if the actual value of currentState 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

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

previous_state

(experimental) previousState property.

Specify an array of string values to match this event if the actual value of previousState 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

query_execution_id

(experimental) queryExecutionId property.

Specify an array of string values to match this event if the actual value of queryExecutionId 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

sequence_number

(experimental) sequenceNumber property.

Specify an array of string values to match this event if the actual value of sequenceNumber 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

statement_type

(experimental) statementType property.

Specify an array of string values to match this event if the actual value of statementType 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

version_id

(experimental) versionId property.

Specify an array of string values to match this event if the actual value of versionId 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

workgroup_name

(experimental) workgroupName property.

Specify an array of string values to match this event if the actual value of workgroupName 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 WorkGroup reference

Stability:

experimental