CfnEndpoint
- class aws_cdk.aws_events.CfnEndpoint(scope, id, *, event_buses, routing_config, description=None, name=None, replication_config=None, role_arn=None)
Bases:
CfnResource
A CloudFormation
AWS::Events::Endpoint
.A global endpoint used to improve your application’s availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .
- CloudformationResource:
AWS::Events::Endpoint
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_events as events cfn_endpoint = events.CfnEndpoint(self, "MyCfnEndpoint", event_buses=[events.CfnEndpoint.EndpointEventBusProperty( event_bus_arn="eventBusArn" )], routing_config=events.CfnEndpoint.RoutingConfigProperty( failover_config=events.CfnEndpoint.FailoverConfigProperty( primary=events.CfnEndpoint.PrimaryProperty( health_check="healthCheck" ), secondary=events.CfnEndpoint.SecondaryProperty( route="route" ) ) ), # the properties below are optional description="description", name="name", replication_config=events.CfnEndpoint.ReplicationConfigProperty( state="state" ), role_arn="roleArn" )
Create a new
AWS::Events::Endpoint
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
event_buses (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,EndpointEventBusProperty
,Dict
[str
,Any
]]]]) – The event buses being used by the endpoint. Exactly :2
routing_config (
Union
[IResolvable
,RoutingConfigProperty
,Dict
[str
,Any
]]) – The routing configuration of the endpoint.description (
Optional
[str
]) – A description for the endpoint.name (
Optional
[str
]) – The name of the endpoint.replication_config (
Union
[IResolvable
,ReplicationConfigProperty
,Dict
[str
,Any
],None
]) – Whether event replication was enabled or disabled for this endpoint. The default state isENABLED
which means you must supply aRoleArn
. If you don’t have aRoleArn
or you don’t want event replication enabled, set the state toDISABLED
.role_arn (
Optional
[str
]) – The ARN of the role used by event replication for the endpoint.
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:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
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:
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" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- 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.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters:
policy (
Optional
[RemovalPolicy
])apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
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:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
)- See:
- Return type:
Any
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.
- 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::Endpoint'
- attr_arn
The ARN of the endpoint.
- CloudformationAttribute:
Arn
- attr_endpoint_id
The ID of the endpoint.
- CloudformationAttribute:
EndpointId
- attr_endpoint_url
The URL of the endpoint.
- CloudformationAttribute:
EndpointUrl
- attr_state
The current state of the endpoint.
- CloudformationAttribute:
State
- attr_state_reason
The reason the endpoint is in its current state.
- CloudformationAttribute:
StateReason
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- 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.
- description
A description for the endpoint.
- event_buses
The event buses being used by the endpoint.
Exactly :
2
- 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)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of the endpoint.
- node
The construct tree node associated with this construct.
- 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 })
.
- replication_config
Whether event replication was enabled or disabled for this endpoint.
The default state is
ENABLED
which means you must supply aRoleArn
. If you don’t have aRoleArn
or you don’t want event replication enabled, set the state toDISABLED
.
- role_arn
The ARN of the role used by event replication for the endpoint.
- routing_config
The routing configuration of the endpoint.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
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
EndpointEventBusProperty
- class CfnEndpoint.EndpointEventBusProperty(*, event_bus_arn)
Bases:
object
The event buses the endpoint is associated with.
- Parameters:
event_bus_arn (
str
) – The ARN of the event bus the endpoint is associated with.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_events as events endpoint_event_bus_property = events.CfnEndpoint.EndpointEventBusProperty( event_bus_arn="eventBusArn" )
Attributes
- event_bus_arn
The ARN of the event bus the endpoint is associated with.
FailoverConfigProperty
- class CfnEndpoint.FailoverConfigProperty(*, primary, secondary)
Bases:
object
The failover configuration for an endpoint.
This includes what triggers failover and what happens when it’s triggered.
- Parameters:
primary (
Union
[IResolvable
,PrimaryProperty
,Dict
[str
,Any
]]) – The main Region of the endpoint.secondary (
Union
[IResolvable
,SecondaryProperty
,Dict
[str
,Any
]]) – The Region that events are routed to when failover is triggered or event replication is enabled.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_events as events failover_config_property = events.CfnEndpoint.FailoverConfigProperty( primary=events.CfnEndpoint.PrimaryProperty( health_check="healthCheck" ), secondary=events.CfnEndpoint.SecondaryProperty( route="route" ) )
Attributes
- primary
The main Region of the endpoint.
- secondary
The Region that events are routed to when failover is triggered or event replication is enabled.
PrimaryProperty
- class CfnEndpoint.PrimaryProperty(*, health_check)
Bases:
object
The primary Region of the endpoint.
- Parameters:
health_check (
str
) – The ARN of the health check used by the endpoint to determine whether failover is triggered.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_events as events primary_property = events.CfnEndpoint.PrimaryProperty( health_check="healthCheck" )
Attributes
- health_check
The ARN of the health check used by the endpoint to determine whether failover is triggered.
ReplicationConfigProperty
- class CfnEndpoint.ReplicationConfigProperty(*, state)
Bases:
object
Endpoints can replicate all events to the secondary Region.
- Parameters:
state (
str
) – The state of event replication.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_events as events replication_config_property = events.CfnEndpoint.ReplicationConfigProperty( state="state" )
Attributes
- state
The state of event replication.
RoutingConfigProperty
- class CfnEndpoint.RoutingConfigProperty(*, failover_config)
Bases:
object
The routing configuration of the endpoint.
- Parameters:
failover_config (
Union
[IResolvable
,FailoverConfigProperty
,Dict
[str
,Any
]]) – The failover configuration for an endpoint. This includes what triggers failover and what happens when it’s triggered.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_events as events routing_config_property = events.CfnEndpoint.RoutingConfigProperty( failover_config=events.CfnEndpoint.FailoverConfigProperty( primary=events.CfnEndpoint.PrimaryProperty( health_check="healthCheck" ), secondary=events.CfnEndpoint.SecondaryProperty( route="route" ) ) )
Attributes
- failover_config
The failover configuration for an endpoint.
This includes what triggers failover and what happens when it’s triggered.
SecondaryProperty
- class CfnEndpoint.SecondaryProperty(*, route)
Bases:
object
The secondary Region that processes events when failover is triggered or replication is enabled.
- Parameters:
route (
str
) – Defines the secondary Region.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_events as events secondary_property = events.CfnEndpoint.SecondaryProperty( route="route" )
Attributes
- route
Defines the secondary Region.