CfnResourceCollection

class aws_cdk.aws_devopsguru.CfnResourceCollection(scope, id, *, resource_collection_filter)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::DevOpsGuru::ResourceCollection.

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.

CloudformationResource

AWS::DevOpsGuru::ResourceCollection

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsguru-resourcecollection.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_devopsguru as devopsguru

cfn_resource_collection = devopsguru.CfnResourceCollection(self, "MyCfnResourceCollection",
    resource_collection_filter=devopsguru.CfnResourceCollection.ResourceCollectionFilterProperty(
        cloud_formation=devopsguru.CfnResourceCollection.CloudFormationCollectionFilterProperty(
            stack_names=["stackNames"]
        ),
        tags=[devopsguru.CfnResourceCollection.TagCollectionProperty(
            app_boundary_key="appBoundaryKey",
            tag_values=["tagValues"]
        )]
    )
)

Create a new AWS::DevOpsGuru::ResourceCollection.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • resource_collection_filter (Union[IResolvable, ResourceCollectionFilterProperty, Dict[str, Any]]) – Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.

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:

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 to addOverride 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: 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::DevOpsGuru::ResourceCollection'
attr_resource_collection_type

The type of AWS resource collections to return.

The one valid value is CLOUD_FORMATION for AWS CloudFormation stacks.

CloudformationAttribute

ResourceCollectionType

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]

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.

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

resource_collection_filter

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

Link

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

Return type

Union[IResolvable, ResourceCollectionFilterProperty]

stack

The stack in which this element is defined.

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

Return type

Stack

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

CloudFormationCollectionFilterProperty

class CfnResourceCollection.CloudFormationCollectionFilterProperty(*, stack_names=None)

Bases: object

Information about AWS CloudFormation stacks.

You can use up to 500 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.

Link

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.
import aws_cdk.aws_devopsguru as devopsguru

cloud_formation_collection_filter_property = devopsguru.CfnResourceCollection.CloudFormationCollectionFilterProperty(
    stack_names=["stackNames"]
)

Attributes

stack_names

An array of CloudFormation stack names.

Link

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

Return type

Optional[List[str]]

ResourceCollectionFilterProperty

class CfnResourceCollection.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 500 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. - An optional 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. 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 . While keys are case-sensitive, the case of key characters don’t matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key / value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .

Link

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.
import aws_cdk.aws_devopsguru as devopsguru

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

Attributes

cloud_formation

Information about AWS CloudFormation stacks.

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

Link

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

Return type

Union[IResolvable, CloudFormationCollectionFilterProperty, None]

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.

  • An optional 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.

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`` . While *keys* are case-sensitive, the case of *key* characters don't matter to DevOps Guru. For example, DevOps Guru works with a *key* named ``devops-guru-rds`` and a *key* named ``DevOps-Guru-RDS`` . Possible *key* / *value* pairs in your application might be ``Devops-Guru-production-application/RDS`` or ``Devops-Guru-production-application/containers`` .
Link

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

Return type

Optional[List[TagCollectionProperty]]

TagCollectionProperty

class CfnResourceCollection.TagCollectionProperty(*, app_boundary_key=None, tag_values=None)

Bases: object

A collection of AWS stags.

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.

  • An optional 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.

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`` . While *keys* are case-sensitive, the case of *key* characters don't matter to DevOps Guru. For example, DevOps Guru works with a *key* named ``devops-guru-rds`` and a *key* named ``DevOps-Guru-RDS`` . 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:: 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 . While keys are case-sensitive, the case of key characters don’t matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . 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 an optional 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.

Link

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.
import aws_cdk.aws_devopsguru as devopsguru

tag_collection_property = devopsguru.CfnResourceCollection.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:

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`` . While *keys* are case-sensitive, the case of *key* characters don't matter to DevOps Guru. For example, DevOps Guru works with a *key* named ``devops-guru-rds`` and a *key* named ``DevOps-Guru-RDS`` . Possible *key* / *value* pairs in your application might be ``Devops-Guru-production-application/RDS`` or ``Devops-Guru-production-application/containers`` .
Link

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

Return type

Optional[str]

tag_values

The values in an AWS tag collection.

The tag’s value is an optional 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.

Link

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

Return type

Optional[List[str]]