CfnRule

class aws_cdk.aws_events.CfnRule(scope, id, *, description=None, event_bus_name=None, event_pattern=None, name=None, role_arn=None, schedule_expression=None, state=None, targets=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Events::Rule.

CloudformationResource

AWS::Events::Rule

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html

Create a new AWS::Events::Rule.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • description (Optional[str]) – AWS::Events::Rule.Description.

  • event_bus_name (Optional[str]) – AWS::Events::Rule.EventBusName.

  • event_pattern (Optional[Any]) – AWS::Events::Rule.EventPattern.

  • name (Optional[str]) – AWS::Events::Rule.Name.

  • role_arn (Optional[str]) – AWS::Events::Rule.RoleArn.

  • schedule_expression (Optional[str]) – AWS::Events::Rule.ScheduleExpression.

  • state (Optional[str]) – AWS::Events::Rule.State.

  • targets (Union[IResolvable, Sequence[Union[IResolvable, TargetProperty]], None]) – AWS::Events::Rule.Targets.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Events::Rule'
attr_arn

Arn

Type

cloudformationAttribute

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

description

AWS::Events::Rule.Description.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description

Return type

Optional[str]

event_bus_name

AWS::Events::Rule.EventBusName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname

Return type

Optional[str]

event_pattern

AWS::Events::Rule.EventPattern.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern

Return type

Any

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

AWS::Events::Rule.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

role_arn

AWS::Events::Rule.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn

Return type

Optional[str]

schedule_expression

AWS::Events::Rule.ScheduleExpression.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression

Return type

Optional[str]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

state

AWS::Events::Rule.State.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state

Return type

Optional[str]

targets

AWS::Events::Rule.Targets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets

Return type

Union[IResolvable, List[Union[IResolvable, TargetProperty]], None]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AwsVpcConfigurationProperty

class CfnRule.AwsVpcConfigurationProperty(*, subnets, assign_public_ip=None, security_groups=None)

Bases: object

Parameters
  • subnets (Sequence[str]) – CfnRule.AwsVpcConfigurationProperty.Subnets.

  • assign_public_ip (Optional[str]) – CfnRule.AwsVpcConfigurationProperty.AssignPublicIp.

  • security_groups (Optional[Sequence[str]]) – CfnRule.AwsVpcConfigurationProperty.SecurityGroups.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html

Attributes

assign_public_ip

CfnRule.AwsVpcConfigurationProperty.AssignPublicIp.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-assignpublicip

Return type

Optional[str]

security_groups

CfnRule.AwsVpcConfigurationProperty.SecurityGroups.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-securitygroups

Return type

Optional[List[str]]

subnets

CfnRule.AwsVpcConfigurationProperty.Subnets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-subnets

Return type

List[str]

BatchArrayPropertiesProperty

class CfnRule.BatchArrayPropertiesProperty(*, size=None)

Bases: object

Parameters

size (Union[int, float, None]) – CfnRule.BatchArrayPropertiesProperty.Size.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html

Attributes

size

CfnRule.BatchArrayPropertiesProperty.Size.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html#cfn-events-rule-batcharrayproperties-size

Return type

Union[int, float, None]

BatchParametersProperty

class CfnRule.BatchParametersProperty(*, job_definition, job_name, array_properties=None, retry_strategy=None)

Bases: object

Parameters
  • job_definition (str) – CfnRule.BatchParametersProperty.JobDefinition.

  • job_name (str) – CfnRule.BatchParametersProperty.JobName.

  • array_properties (Union[IResolvable, BatchArrayPropertiesProperty, None]) – CfnRule.BatchParametersProperty.ArrayProperties.

  • retry_strategy (Union[IResolvable, BatchRetryStrategyProperty, None]) – CfnRule.BatchParametersProperty.RetryStrategy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html

Attributes

array_properties

CfnRule.BatchParametersProperty.ArrayProperties.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-arrayproperties

Return type

Union[IResolvable, BatchArrayPropertiesProperty, None]

job_definition

CfnRule.BatchParametersProperty.JobDefinition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobdefinition

Return type

str

job_name

CfnRule.BatchParametersProperty.JobName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobname

Return type

str

retry_strategy

CfnRule.BatchParametersProperty.RetryStrategy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-retrystrategy

Return type

Union[IResolvable, BatchRetryStrategyProperty, None]

BatchRetryStrategyProperty

class CfnRule.BatchRetryStrategyProperty(*, attempts=None)

Bases: object

Parameters

attempts (Union[int, float, None]) – CfnRule.BatchRetryStrategyProperty.Attempts.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html

Attributes

attempts

CfnRule.BatchRetryStrategyProperty.Attempts.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html#cfn-events-rule-batchretrystrategy-attempts

Return type

Union[int, float, None]

DeadLetterConfigProperty

class CfnRule.DeadLetterConfigProperty(*, arn=None)

Bases: object

Parameters

arn (Optional[str]) – CfnRule.DeadLetterConfigProperty.Arn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html

Attributes

arn

CfnRule.DeadLetterConfigProperty.Arn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn

Return type

Optional[str]

EcsParametersProperty

class CfnRule.EcsParametersProperty(*, task_definition_arn, group=None, launch_type=None, network_configuration=None, platform_version=None, task_count=None)

Bases: object

Parameters
  • task_definition_arn (str) – CfnRule.EcsParametersProperty.TaskDefinitionArn.

  • group (Optional[str]) – CfnRule.EcsParametersProperty.Group.

  • launch_type (Optional[str]) – CfnRule.EcsParametersProperty.LaunchType.

  • network_configuration (Union[IResolvable, NetworkConfigurationProperty, None]) – CfnRule.EcsParametersProperty.NetworkConfiguration.

  • platform_version (Optional[str]) – CfnRule.EcsParametersProperty.PlatformVersion.

  • task_count (Union[int, float, None]) – CfnRule.EcsParametersProperty.TaskCount.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html

Attributes

group

CfnRule.EcsParametersProperty.Group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-group

Return type

Optional[str]

launch_type

CfnRule.EcsParametersProperty.LaunchType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-launchtype

Return type

Optional[str]

network_configuration

CfnRule.EcsParametersProperty.NetworkConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-networkconfiguration

Return type

Union[IResolvable, NetworkConfigurationProperty, None]

platform_version

CfnRule.EcsParametersProperty.PlatformVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-platformversion

Return type

Optional[str]

task_count

CfnRule.EcsParametersProperty.TaskCount.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskcount

Return type

Union[int, float, None]

task_definition_arn

CfnRule.EcsParametersProperty.TaskDefinitionArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskdefinitionarn

Return type

str

HttpParametersProperty

class CfnRule.HttpParametersProperty(*, header_parameters=None, path_parameter_values=None, query_string_parameters=None)

Bases: object

Parameters
  • header_parameters (Union[IResolvable, Mapping[str, str], None]) – CfnRule.HttpParametersProperty.HeaderParameters.

  • path_parameter_values (Optional[Sequence[str]]) – CfnRule.HttpParametersProperty.PathParameterValues.

  • query_string_parameters (Union[IResolvable, Mapping[str, str], None]) – CfnRule.HttpParametersProperty.QueryStringParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html

Attributes

header_parameters

CfnRule.HttpParametersProperty.HeaderParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-headerparameters

Return type

Union[IResolvable, Mapping[str, str], None]

path_parameter_values

CfnRule.HttpParametersProperty.PathParameterValues.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-pathparametervalues

Return type

Optional[List[str]]

query_string_parameters

CfnRule.HttpParametersProperty.QueryStringParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-querystringparameters

Return type

Union[IResolvable, Mapping[str, str], None]

InputTransformerProperty

class CfnRule.InputTransformerProperty(*, input_template, input_paths_map=None)

Bases: object

Parameters
  • input_template (str) – CfnRule.InputTransformerProperty.InputTemplate.

  • input_paths_map (Union[IResolvable, Mapping[str, str], None]) – CfnRule.InputTransformerProperty.InputPathsMap.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html

Attributes

input_paths_map

CfnRule.InputTransformerProperty.InputPathsMap.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputpathsmap

Return type

Union[IResolvable, Mapping[str, str], None]

input_template

CfnRule.InputTransformerProperty.InputTemplate.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputtemplate

Return type

str

KinesisParametersProperty

class CfnRule.KinesisParametersProperty(*, partition_key_path)

Bases: object

Parameters

partition_key_path (str) – CfnRule.KinesisParametersProperty.PartitionKeyPath.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html

Attributes

partition_key_path

CfnRule.KinesisParametersProperty.PartitionKeyPath.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html#cfn-events-rule-kinesisparameters-partitionkeypath

Return type

str

NetworkConfigurationProperty

class CfnRule.NetworkConfigurationProperty(*, aws_vpc_configuration=None)

Bases: object

Parameters

aws_vpc_configuration (Union[IResolvable, AwsVpcConfigurationProperty, None]) – CfnRule.NetworkConfigurationProperty.AwsVpcConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html

Attributes

aws_vpc_configuration

CfnRule.NetworkConfigurationProperty.AwsVpcConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html#cfn-events-rule-networkconfiguration-awsvpcconfiguration

Return type

Union[IResolvable, AwsVpcConfigurationProperty, None]

RedshiftDataParametersProperty

class CfnRule.RedshiftDataParametersProperty(*, database, sql, db_user=None, secret_manager_arn=None, statement_name=None, with_event=None)

Bases: object

Parameters
  • database (str) – CfnRule.RedshiftDataParametersProperty.Database.

  • sql (str) – CfnRule.RedshiftDataParametersProperty.Sql.

  • db_user (Optional[str]) – CfnRule.RedshiftDataParametersProperty.DbUser.

  • secret_manager_arn (Optional[str]) – CfnRule.RedshiftDataParametersProperty.SecretManagerArn.

  • statement_name (Optional[str]) – CfnRule.RedshiftDataParametersProperty.StatementName.

  • with_event (Union[bool, IResolvable, None]) – CfnRule.RedshiftDataParametersProperty.WithEvent.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html

Attributes

database

CfnRule.RedshiftDataParametersProperty.Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-database

Return type

str

db_user

CfnRule.RedshiftDataParametersProperty.DbUser.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-dbuser

Return type

Optional[str]

secret_manager_arn

CfnRule.RedshiftDataParametersProperty.SecretManagerArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-secretmanagerarn

Return type

Optional[str]

sql

CfnRule.RedshiftDataParametersProperty.Sql.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-sql

Return type

str

statement_name

CfnRule.RedshiftDataParametersProperty.StatementName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-statementname

Return type

Optional[str]

with_event

CfnRule.RedshiftDataParametersProperty.WithEvent.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-withevent

Return type

Union[bool, IResolvable, None]

RetryPolicyProperty

class CfnRule.RetryPolicyProperty(*, maximum_event_age_in_seconds=None, maximum_retry_attempts=None)

Bases: object

Parameters
  • maximum_event_age_in_seconds (Union[int, float, None]) – CfnRule.RetryPolicyProperty.MaximumEventAgeInSeconds.

  • maximum_retry_attempts (Union[int, float, None]) – CfnRule.RetryPolicyProperty.MaximumRetryAttempts.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html

Attributes

maximum_event_age_in_seconds

CfnRule.RetryPolicyProperty.MaximumEventAgeInSeconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html#cfn-events-rule-retrypolicy-maximumeventageinseconds

Return type

Union[int, float, None]

maximum_retry_attempts

CfnRule.RetryPolicyProperty.MaximumRetryAttempts.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html#cfn-events-rule-retrypolicy-maximumretryattempts

Return type

Union[int, float, None]

RunCommandParametersProperty

class CfnRule.RunCommandParametersProperty(*, run_command_targets)

Bases: object

Parameters

run_command_targets (Union[IResolvable, Sequence[Union[IResolvable, RunCommandTargetProperty]]]) – CfnRule.RunCommandParametersProperty.RunCommandTargets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html

Attributes

run_command_targets

CfnRule.RunCommandParametersProperty.RunCommandTargets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html#cfn-events-rule-runcommandparameters-runcommandtargets

Return type

Union[IResolvable, List[Union[IResolvable, RunCommandTargetProperty]]]

RunCommandTargetProperty

class CfnRule.RunCommandTargetProperty(*, key, values)

Bases: object

Parameters
  • key (str) – CfnRule.RunCommandTargetProperty.Key.

  • values (Sequence[str]) – CfnRule.RunCommandTargetProperty.Values.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html

Attributes

key

CfnRule.RunCommandTargetProperty.Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-key

Return type

str

values

CfnRule.RunCommandTargetProperty.Values.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-values

Return type

List[str]

SqsParametersProperty

class CfnRule.SqsParametersProperty(*, message_group_id)

Bases: object

Parameters

message_group_id (str) – CfnRule.SqsParametersProperty.MessageGroupId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html

Attributes

message_group_id

CfnRule.SqsParametersProperty.MessageGroupId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html#cfn-events-rule-sqsparameters-messagegroupid

Return type

str

TargetProperty

class CfnRule.TargetProperty(*, arn, id, batch_parameters=None, dead_letter_config=None, ecs_parameters=None, http_parameters=None, input=None, input_path=None, input_transformer=None, kinesis_parameters=None, redshift_data_parameters=None, retry_policy=None, role_arn=None, run_command_parameters=None, sqs_parameters=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html

Attributes

arn

CfnRule.TargetProperty.Arn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-arn

Return type

str

batch_parameters

CfnRule.TargetProperty.BatchParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-batchparameters

Return type

Union[IResolvable, BatchParametersProperty, None]

dead_letter_config

CfnRule.TargetProperty.DeadLetterConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig

Return type

Union[IResolvable, DeadLetterConfigProperty, None]

ecs_parameters

CfnRule.TargetProperty.EcsParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-ecsparameters

Return type

Union[IResolvable, EcsParametersProperty, None]

http_parameters

CfnRule.TargetProperty.HttpParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-httpparameters

Return type

Union[IResolvable, HttpParametersProperty, None]

id

CfnRule.TargetProperty.Id.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id

Return type

str

input

CfnRule.TargetProperty.Input.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input

Return type

Optional[str]

input_path

CfnRule.TargetProperty.InputPath.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath

Return type

Optional[str]

input_transformer

CfnRule.TargetProperty.InputTransformer.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer

Return type

Union[IResolvable, InputTransformerProperty, None]

kinesis_parameters

CfnRule.TargetProperty.KinesisParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-kinesisparameters

Return type

Union[IResolvable, KinesisParametersProperty, None]

redshift_data_parameters

CfnRule.TargetProperty.RedshiftDataParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-redshiftdataparameters

Return type

Union[IResolvable, RedshiftDataParametersProperty, None]

retry_policy

CfnRule.TargetProperty.RetryPolicy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy

Return type

Union[IResolvable, RetryPolicyProperty, None]

role_arn

CfnRule.TargetProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-rolearn

Return type

Optional[str]

run_command_parameters

CfnRule.TargetProperty.RunCommandParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-runcommandparameters

Return type

Union[IResolvable, RunCommandParametersProperty, None]

sqs_parameters

CfnRule.TargetProperty.SqsParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-sqsparameters

Return type

Union[IResolvable, SqsParametersProperty, None]