CfnResourceCollectionPropsMixin

class aws_cdk.mixins_preview.aws_devopsguru.mixins.CfnResourceCollectionPropsMixin(props, *, strategy=None)

Bases: Mixin

A collection of AWS resources supported by DevOps Guru.

The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsguru-resourcecollection.html
CloudformationResource:: AWS::DevOpsGuru::ResourceCollection
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_devopsguru import mixins as devopsguru_mixins

cfn_resource_collection_props_mixin = devopsguru_mixins.CfnResourceCollectionPropsMixin(devopsguru_mixins.CfnResourceCollectionMixinProps(
    resource_collection_filter=devopsguru_mixins.CfnResourceCollectionPropsMixin.ResourceCollectionFilterProperty(
        cloud_formation=devopsguru_mixins.CfnResourceCollectionPropsMixin.CloudFormationCollectionFilterProperty(
            stack_names=["stackNames"]
        ),
        tags=[devopsguru_mixins.CfnResourceCollectionPropsMixin.TagCollectionProperty(
            app_boundary_key="appBoundaryKey",
            tag_values=["tagValues"]
        )]
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::DevOpsGuru::ResourceCollection.

Parameters:

props (Union[CfnResourceCollectionMixinProps, 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 = ['resourceCollectionFilter']

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

CloudFormationCollectionFilterProperty

class CfnResourceCollectionPropsMixin.CloudFormationCollectionFilterProperty(*, stack_names=None)

Bases: object

Information about AWS CloudFormation stacks.

You can use up to 1000 stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide .

Parameters:: stack_names (Optional[Sequence[str]]) – An array of CloudFormation stack names.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-cloudformationcollectionfilter.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_devopsguru import mixins as devopsguru_mixins

cloud_formation_collection_filter_property = devopsguru_mixins.CfnResourceCollectionPropsMixin.CloudFormationCollectionFilterProperty(
    stack_names=["stackNames"]
)

Attributes

stack_names

An array of CloudFormation stack names.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-cloudformationcollectionfilter.html#cfn-devopsguru-resourcecollection-cloudformationcollectionfilter-stacknames

ResourceCollectionFilterProperty

class CfnResourceCollectionPropsMixin.ResourceCollectionFilterProperty(*, cloud_formation=None, tags=None)

Bases: object

Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.

Parameters:

cloud_formation (Union[IResolvable, CloudFormationCollectionFilterProperty, Dict[str, Any], None]) –
Information about AWS CloudFormation stacks. You can use up to 1000 stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide .
tags (Optional[Sequence[Union[TagCollectionProperty, Dict[str, Any]]]]) – The AWS tags used to filter the resources in the resource collection. Tags help you identify and organize your AWS resources. Many AWS services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an AWS Lambda function. For more information about using tags, see the Tagging best practices whitepaper. Each AWS tag has two parts. - A tag key (for example, CostCenter , Environment , Project , or Secret ). Tag keys are case-sensitive. - A field known as a tag value (for example, 111122223333 , Production , or a team name). Omitting the tag value is the same as using an empty string. Like tag keys , tag values are case-sensitive. The tag value is a required property when AppBoundaryKey is specified. Together these are known as key - value pairs. .. epigraph:: The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru- . The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application . When you create a key , the case of characters in the key can be whatever you choose. After you create a key , it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS , and these act as two different keys . Possible key / value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-resourcecollectionfilter.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_devopsguru import mixins as devopsguru_mixins

resource_collection_filter_property = devopsguru_mixins.CfnResourceCollectionPropsMixin.ResourceCollectionFilterProperty(
    cloud_formation=devopsguru_mixins.CfnResourceCollectionPropsMixin.CloudFormationCollectionFilterProperty(
        stack_names=["stackNames"]
    ),
    tags=[devopsguru_mixins.CfnResourceCollectionPropsMixin.TagCollectionProperty(
        app_boundary_key="appBoundaryKey",
        tag_values=["tagValues"]
    )]
)

Attributes

cloud_formation

Information about AWS CloudFormation stacks.

You can use up to 1000 stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-resourcecollectionfilter.html#cfn-devopsguru-resourcecollection-resourcecollectionfilter-cloudformation

tags

The AWS tags used to filter the resources in the resource collection.

Tags help you identify and organize your AWS resources. Many AWS services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an AWS Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each AWS tag has two parts.

A tag key (for example, CostCenter , Environment , Project , or Secret ). Tag keys are case-sensitive.
A field known as a tag value (for example, 111122223333 , Production , or a team name). Omitting the tag value is the same as using an empty string. Like tag keys , tag values are case-sensitive. The tag value is a required property when AppBoundaryKey is specified.

Together these are known as key - value pairs. .. epigraph:

The string used for a *key* in a tag that you use to define your resource coverage must begin with the prefix ``Devops-guru-`` . The tag *key* might be ``DevOps-Guru-deployment-application`` or ``devops-guru-rds-application`` . When you create a *key* , the case of characters in the *key* can be whatever you choose. After you create a *key* , it is case-sensitive. For example, DevOps Guru works with a *key* named ``devops-guru-rds`` and a *key* named ``DevOps-Guru-RDS`` , and these act as two different *keys* . Possible *key* / *value* pairs in your application might be ``Devops-Guru-production-application/RDS`` or ``Devops-Guru-production-application/containers`` .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-resourcecollectionfilter.html#cfn-devopsguru-resourcecollection-resourcecollectionfilter-tags

TagCollectionProperty

class CfnResourceCollectionPropsMixin.TagCollectionProperty(*, app_boundary_key=None, tag_values=None)

Bases: object

A collection of AWS tags.

Tags help you identify and organize your AWS resources. Many AWS services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an AWS Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each AWS tag has two parts.

A tag key (for example, CostCenter , Environment , Project , or Secret ). Tag keys are case-sensitive.
A field known as a tag value (for example, 111122223333 , Production , or a team name). Omitting the tag value is the same as using an empty string. Like tag keys , tag values are case-sensitive. The tag value is a required property when AppBoundaryKey is specified.

Together these are known as key - value pairs. .. epigraph:

The string used for a *key* in a tag that you use to define your resource coverage must begin with the prefix ``Devops-guru-`` . The tag *key* might be ``DevOps-Guru-deployment-application`` or ``devops-guru-rds-application`` . When you create a *key* , the case of characters in the *key* can be whatever you choose. After you create a *key* , it is case-sensitive. For example, DevOps Guru works with a *key* named ``devops-guru-rds`` and a *key* named ``DevOps-Guru-RDS`` , and these act as two different *keys* . Possible *key* / *value* pairs in your application might be ``Devops-Guru-production-application/RDS`` or ``Devops-Guru-production-application/containers`` .

Parameters:

app_boundary_key (Optional[str]) – An AWS tag key that is used to identify the AWS resources that DevOps Guru analyzes. All AWS resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary. .. epigraph:: When you create a key , the case of characters in the key can be whatever you choose. After you create a key , it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS , and these act as two different keys . Possible key / value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
tag_values (Optional[Sequence[str]]) – The values in an AWS tag collection. The tag’s value is a field used to associate a string with the tag key (for example, 111122223333 , Production , or a team name). The key and value are the tag’s key pair. Omitting the tag value is the same as using an empty string. Like tag keys , tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value. The tag value is a required property when AppBoundaryKey is specified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-tagcollection.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_devopsguru import mixins as devopsguru_mixins

tag_collection_property = devopsguru_mixins.CfnResourceCollectionPropsMixin.TagCollectionProperty(
    app_boundary_key="appBoundaryKey",
    tag_values=["tagValues"]
)

Attributes

app_boundary_key

An AWS tag key that is used to identify the AWS resources that DevOps Guru analyzes.

All AWS resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary. .. epigraph:

When you create a *key* , the case of characters in the *key* can be whatever you choose. After you create a *key* , it is case-sensitive. For example, DevOps Guru works with a *key* named ``devops-guru-rds`` and a *key* named ``DevOps-Guru-RDS`` , and these act as two different *keys* . Possible *key* / *value* pairs in your application might be ``Devops-Guru-production-application/RDS`` or ``Devops-Guru-production-application/containers`` .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-tagcollection.html#cfn-devopsguru-resourcecollection-tagcollection-appboundarykey

tag_values

The values in an AWS tag collection.

The tag’s value is a field used to associate a string with the tag key (for example, 111122223333 , Production , or a team name). The key and value are the tag’s key pair. Omitting the tag value is the same as using an empty string. Like tag keys , tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value. The tag value is a required property when AppBoundaryKey is specified.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-tagcollection.html#cfn-devopsguru-resourcecollection-tagcollection-tagvalues