Package software.amazon.awscdk.cfnpropertymixins.services.resourceexplorer2

Class CfnViewPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.resourceexplorer2.CfnViewPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnViewPropsMixin>

Enclosing class:

CfnViewPropsMixin

@Stability(Stable)
public static final class CfnViewPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnViewPropsMixin>

A fluent builder for CfnViewPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnViewPropsMixin	build()
static CfnViewPropsMixin.Builder	create()
static CfnViewPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnViewPropsMixin.Builder	filters(CfnViewPropsMixin.FiltersProperty filters)	An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view.
CfnViewPropsMixin.Builder	filters(IResolvable filters)	An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view.
CfnViewPropsMixin.Builder	includedProperties(List<? extends Object> includedProperties)	A list of fields that provide additional information about the view.
CfnViewPropsMixin.Builder	includedProperties(IResolvable includedProperties)	A list of fields that provide additional information about the view.
CfnViewPropsMixin.Builder	scope(String scope)	The root ARN of the account, an organizational unit (OU), or an organization ARN.
CfnViewPropsMixin.Builder	tags(Map<String,String> tags)	Tag key and value pairs that are attached to the view.
CfnViewPropsMixin.Builder	viewName(String viewName)	The name of the new view.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnViewPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnViewPropsMixin.Builder.

create

@Stability(Stable)
public static CfnViewPropsMixin.Builder create()

Returns:

a new instance of CfnViewPropsMixin.Builder.

filters

@Stability(Stable)
public CfnViewPropsMixin.Builder filters(IResolvable filters)

An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view.

When you use this view in a Search operation, the filter string is combined with the search's QueryString parameter using a logical AND operator.

For information about the supported syntax, see Search query reference for Resource Explorer in the AWS Resource Explorer User Guide .

This query string in the context of this operation supports only filter prefixes with optional operators . It doesn't support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any AWS Region that begin with the letters us and are not tagged with a key Stage that has the value prod .

Parameters:

filters - An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-filters

filters

@Stability(Stable)
public CfnViewPropsMixin.Builder filters(CfnViewPropsMixin.FiltersProperty filters)

An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view.

When you use this view in a Search operation, the filter string is combined with the search's QueryString parameter using a logical AND operator.

For information about the supported syntax, see Search query reference for Resource Explorer in the AWS Resource Explorer User Guide .

This query string in the context of this operation supports only filter prefixes with optional operators . It doesn't support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any AWS Region that begin with the letters us and are not tagged with a key Stage that has the value prod .

Parameters:

filters - An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-filters

includedProperties

@Stability(Stable)
public CfnViewPropsMixin.Builder includedProperties(IResolvable includedProperties)

A list of fields that provide additional information about the view.

Parameters:

includedProperties - A list of fields that provide additional information about the view. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-includedproperties

includedProperties

@Stability(Stable)
public CfnViewPropsMixin.Builder includedProperties(List<? extends Object> includedProperties)

A list of fields that provide additional information about the view.

Parameters:

includedProperties - A list of fields that provide additional information about the view. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-includedproperties

scope

@Stability(Stable)
public CfnViewPropsMixin.Builder scope(String scope)

The root ARN of the account, an organizational unit (OU), or an organization ARN.

If left empty, the default is account.

Parameters:

scope - The root ARN of the account, an organizational unit (OU), or an organization ARN. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-scope

tags

@Stability(Stable)
public CfnViewPropsMixin.Builder tags(Map<String,String> tags)

Tag key and value pairs that are attached to the view.

Parameters:

tags - Tag key and value pairs that are attached to the view. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-tags

viewName

@Stability(Stable)
public CfnViewPropsMixin.Builder viewName(String viewName)

The name of the new view.

Parameters:

viewName - The name of the new view. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-viewname

build

@Stability(Stable)
public CfnViewPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnViewPropsMixin>

Returns:

a newly built instance of CfnViewPropsMixin.