CfnPublishingDestinationPropsMixin

class aws_cdk.mixins_preview.aws_guardduty.mixins.CfnPublishingDestinationPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a publishing destination where you can export your GuardDuty findings.

Before you start exporting the findings, the destination resource must exist.

For more information about considerations and permissions, see Exporting GuardDuty findings to Amazon S3 buckets in the Amazon GuardDuty User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-publishingdestination.html
CloudformationResource:: AWS::GuardDuty::PublishingDestination
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_guardduty import mixins as guardduty_mixins

cfn_publishing_destination_props_mixin = guardduty_mixins.CfnPublishingDestinationPropsMixin(guardduty_mixins.CfnPublishingDestinationMixinProps(
    destination_properties=guardduty_mixins.CfnPublishingDestinationPropsMixin.CFNDestinationPropertiesProperty(
        destination_arn="destinationArn",
        kms_key_arn="kmsKeyArn"
    ),
    destination_type="destinationType",
    detector_id="detectorId",
    tags=[guardduty_mixins.CfnPublishingDestinationPropsMixin.TagItemProperty(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::GuardDuty::PublishingDestination.

Parameters:

props (Union[CfnPublishingDestinationMixinProps, 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:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['destinationProperties', 'destinationType', 'detectorId', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CFNDestinationPropertiesProperty

class CfnPublishingDestinationPropsMixin.CFNDestinationPropertiesProperty(*, destination_arn=None, kms_key_arn=None)

Bases: object

Contains the Amazon Resource Name (ARN) of the resource that receives the published findings, such as an S3 bucket, and the ARN of the KMS key that is used to encrypt these published findings.

Parameters:

destination_arn (Optional[str]) – The ARN of the resource where the findings are published.
kms_key_arn (Optional[str]) – The ARN of the KMS key to use for encryption.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-publishingdestination-cfndestinationproperties.html

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_guardduty import mixins as guardduty_mixins

c_fNDestination_properties_property = guardduty_mixins.CfnPublishingDestinationPropsMixin.CFNDestinationPropertiesProperty(
    destination_arn="destinationArn",
    kms_key_arn="kmsKeyArn"
)

Attributes

destination_arn

The ARN of the resource where the findings are published.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-publishingdestination-cfndestinationproperties.html#cfn-guardduty-publishingdestination-cfndestinationproperties-destinationarn

kms_key_arn

The ARN of the KMS key to use for encryption.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-publishingdestination-cfndestinationproperties.html#cfn-guardduty-publishingdestination-cfndestinationproperties-kmskeyarn

TagItemProperty

class CfnPublishingDestinationPropsMixin.TagItemProperty(*, key=None, value=None)

Bases: object

Describes a tag.

Parameters:

key (Optional[str]) – The tag key.
value (Optional[str]) – The tag value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-publishingdestination-tagitem.html

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_guardduty import mixins as guardduty_mixins

tag_item_property = guardduty_mixins.CfnPublishingDestinationPropsMixin.TagItemProperty(
    key="key",
    value="value"
)

Attributes

key

The tag key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-publishingdestination-tagitem.html#cfn-guardduty-publishingdestination-tagitem-key

value

The tag value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-publishingdestination-tagitem.html#cfn-guardduty-publishingdestination-tagitem-value