software.amazon.awscdk.services.config

Class CfnStoredQuery

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.config.CfnStoredQuery

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.736Z")
 @Stability(value=Stable)
public class CfnStoredQuery
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Config::StoredQuery`.

Provides the details of a stored query.

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.config.*;
 CfnStoredQuery cfnStoredQuery = CfnStoredQuery.Builder.create(this, "MyCfnStoredQuery")
         .queryExpression("queryExpression")
         .queryName("queryName")
         // the properties below are optional
         .queryDescription("queryDescription")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnStoredQuery.Builder A fluent builder for CfnStoredQuery.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStoredQuery(software.constructs.Construct scope, String id, CfnStoredQueryProps props) Create a new `AWS::Config::StoredQuery`.
protected	CfnStoredQuery(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStoredQuery(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrQueryArn() Amazon Resource Name (ARN) of the query.
String	getAttrQueryId() The ID of the query.
protected Map<String,Object>	getCfnProperties()
String	getQueryDescription() A unique description for the query.
String	getQueryExpression() The expression of the query.
String	getQueryName() The name of the query.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setQueryDescription(String value) A unique description for the query.
void	setQueryExpression(String value) The expression of the query.
void	setQueryName(String value) The name of the query.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStoredQuery

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

CfnStoredQuery

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

CfnStoredQuery

@Stability(value=Stable)
public CfnStoredQuery(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnStoredQueryProps props)

Create a new `AWS::Config::StoredQuery`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrQueryArn

@Stability(value=Stable)
 @NotNull
public String getAttrQueryArn()

Amazon Resource Name (ARN) of the query.

For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

getAttrQueryId

@Stability(value=Stable)
 @NotNull
public String getAttrQueryId()

The ID of the query.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of key-value pairs to apply to this resource.

getQueryExpression

@Stability(value=Stable)
 @NotNull
public String getQueryExpression()

The expression of the query.

For example, SELECT resourceId, resourceType, supplementaryConfiguration.BucketVersioningConfiguration.status WHERE resourceType = 'AWS::S3::Bucket' AND supplementaryConfiguration.BucketVersioningConfiguration.status = 'Off'.

setQueryExpression

@Stability(value=Stable)
public void setQueryExpression(@NotNull
                                                        String value)

The expression of the query.

For example, SELECT resourceId, resourceType, supplementaryConfiguration.BucketVersioningConfiguration.status WHERE resourceType = 'AWS::S3::Bucket' AND supplementaryConfiguration.BucketVersioningConfiguration.status = 'Off'.

getQueryName

@Stability(value=Stable)
 @NotNull
public String getQueryName()

The name of the query.

setQueryName

@Stability(value=Stable)
public void setQueryName(@NotNull
                                                  String value)

The name of the query.

getQueryDescription

@Stability(value=Stable)
 @Nullable
public String getQueryDescription()

A unique description for the query.

setQueryDescription

@Stability(value=Stable)
public void setQueryDescription(@Nullable
                                                         String value)

A unique description for the query.