Package software.amazon.awscdk.services.devopsguru

Class CfnResourceCollection

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.devopsguru.CfnResourceCollection

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:05.283Z")
@Stability(Stable)
public class CfnResourceCollection
extends CfnResource
implements IInspectable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.devopsguru.*;
 CfnResourceCollection cfnResourceCollection = CfnResourceCollection.Builder.create(this, "MyCfnResourceCollection")
         .resourceCollectionFilter(ResourceCollectionFilterProperty.builder()
                 .cloudFormation(CloudFormationCollectionFilterProperty.builder()
                         .stackNames(List.of("stackNames"))
                         .build())
                 .tags(List.of(TagCollectionProperty.builder()
                         .appBoundaryKey("appBoundaryKey")
                         .tagValues(List.of("tagValues"))
                         .build()))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnResourceCollection.Builder	A fluent builder for CfnResourceCollection.
static interface	CfnResourceCollection.CloudFormationCollectionFilterProperty	Information about AWS CloudFormation stacks.
static interface	CfnResourceCollection.ResourceCollectionFilterProperty	Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.
static interface	CfnResourceCollection.TagCollectionProperty	A collection of AWS tags.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnResourceCollection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnResourceCollection(software.amazon.jsii.JsiiObjectRef objRef)
	CfnResourceCollection(software.constructs.Construct scope, String id, CfnResourceCollectionProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrResourceCollectionType()	The type of AWS resource collections to return.
protected Map<String,Object>	getCfnProperties()
Object	getResourceCollectionFilter()	Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setResourceCollectionFilter(IResolvable value)	Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.
void	setResourceCollectionFilter(CfnResourceCollection.ResourceCollectionFilterProperty value)	Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnResourceCollection

protected CfnResourceCollection(software.amazon.jsii.JsiiObjectRef objRef)

CfnResourceCollection

protected CfnResourceCollection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnResourceCollection

@Stability(Stable)
public CfnResourceCollection(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnResourceCollectionProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrResourceCollectionType

@Stability(Stable)
@NotNull
public String getAttrResourceCollectionType()

The type of AWS resource collections to return.

The one valid value is CLOUD_FORMATION for AWS CloudFormation stacks.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getResourceCollectionFilter

@Stability(Stable)
@NotNull
public Object getResourceCollectionFilter()

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

setResourceCollectionFilter

@Stability(Stable)
public void setResourceCollectionFilter(@NotNull
 IResolvable value)

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

setResourceCollectionFilter

@Stability(Stable)
public void setResourceCollectionFilter(@NotNull
 CfnResourceCollection.ResourceCollectionFilterProperty value)

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