CfnDeliveryDestinationPropsMixin
- class aws_cdk.mixins_preview.aws_logs.mixins.CfnDeliveryDestinationPropsMixin(props, *, strategy=None)
Bases:
MixinThis structure contains information about one delivery destination in your account.
A delivery destination is an AWS resource that represents an AWS service that logs can be sent to. CloudWatch Logs, Amazon S3, Firehose, and X-Ray are supported as delivery destinations.
To configure logs delivery between a supported AWS service and a destination, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource .
Create a delivery destination , which is a logical object that represents the actual delivery destination.
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery .
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
- See:
- CloudformationResource:
AWS::Logs::DeliveryDestination
- Mixin:
true
- 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 import mixins from aws_cdk.mixins_preview.aws_logs import mixins as logs_mixins # delivery_destination_policy: Any cfn_delivery_destination_props_mixin = logs_mixins.CfnDeliveryDestinationPropsMixin(logs_mixins.CfnDeliveryDestinationMixinProps( delivery_destination_policy=logs_mixins.CfnDeliveryDestinationPropsMixin.DestinationPolicyProperty( delivery_destination_name="deliveryDestinationName", delivery_destination_policy=delivery_destination_policy ), delivery_destination_type="deliveryDestinationType", destination_resource_arn="destinationResourceArn", name="name", output_format="outputFormat", tags=[CfnTag( key="key", value="value" )] ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::Logs::DeliveryDestination.- Parameters:
props (
Union[CfnDeliveryDestinationMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['deliveryDestinationPolicy', 'deliveryDestinationType', 'destinationResourceArn', 'name', 'outputFormat', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
DestinationPolicyProperty
- class CfnDeliveryDestinationPropsMixin.DestinationPolicyProperty(*, delivery_destination_name=None, delivery_destination_policy=None)
Bases:
objectAn IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.
- Parameters:
delivery_destination_name (
Optional[str]) – A name for an existing destination.delivery_destination_policy (
Any) – Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.
- See:
- 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_logs import mixins as logs_mixins # delivery_destination_policy: Any destination_policy_property = logs_mixins.CfnDeliveryDestinationPropsMixin.DestinationPolicyProperty( delivery_destination_name="deliveryDestinationName", delivery_destination_policy=delivery_destination_policy )
Attributes
- delivery_destination_name
A name for an existing destination.
- delivery_destination_policy
Creates or updates an access policy associated with an existing destination.
An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.