Package software.amazon.awscdk.cloud_assembly_schema

Class CcApiContextQuery.Builder

java.lang.Object

software.amazon.awscdk.cloud_assembly_schema.CcApiContextQuery.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CcApiContextQuery>

Enclosing interface:

CcApiContextQuery

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

A builder for CcApiContextQuery

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CcApiContextQuery.Builder	account(String account)	Sets the value of ContextLookupRoleOptions.getAccount()
CcApiContextQuery.Builder	assumeRoleAdditionalOptions(Map<String,? extends Object> assumeRoleAdditionalOptions)	Sets the value of ContextLookupRoleOptions.getAssumeRoleAdditionalOptions()
CcApiContextQuery	build()	Builds the configured instance.
CcApiContextQuery.Builder	exactIdentifier(String exactIdentifier)	Sets the value of CcApiContextQuery.getExactIdentifier()
CcApiContextQuery.Builder	lookupRoleArn(String lookupRoleArn)	Sets the value of ContextLookupRoleOptions.getLookupRoleArn()
CcApiContextQuery.Builder	lookupRoleExternalId(String lookupRoleExternalId)	Sets the value of ContextLookupRoleOptions.getLookupRoleExternalId()
CcApiContextQuery.Builder	propertiesToReturn(List<String> propertiesToReturn)	Sets the value of CcApiContextQuery.getPropertiesToReturn()
CcApiContextQuery.Builder	propertyMatch(Map<String,? extends Object> propertyMatch)	Sets the value of CcApiContextQuery.getPropertyMatch()
CcApiContextQuery.Builder	region(String region)	Sets the value of ContextLookupRoleOptions.getRegion()
CcApiContextQuery.Builder	typeName(String typeName)	Sets the value of CcApiContextQuery.getTypeName()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

propertiesToReturn

@Stability(Stable)
public CcApiContextQuery.Builder propertiesToReturn(List<String> propertiesToReturn)

Sets the value of CcApiContextQuery.getPropertiesToReturn()

Parameters:

propertiesToReturn - This is a set of properties returned from CC API that we want to return from ContextQuery. This parameter is required.

Returns:

this

typeName

@Stability(Stable)
public CcApiContextQuery.Builder typeName(String typeName)

Sets the value of CcApiContextQuery.getTypeName()

Parameters:

typeName - The Cloudformation resource type. This parameter is required. See https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/supported-resources.html

Returns:

this

exactIdentifier

@Stability(Stable)
public CcApiContextQuery.Builder exactIdentifier(String exactIdentifier)

Sets the value of CcApiContextQuery.getExactIdentifier()

Parameters:

exactIdentifier - exactIdentifier of the resource. Specifying exactIdentifier will return at most one result. Either exactIdentifier or propertyMatch should be specified.

Returns:

this

propertyMatch

@Stability(Stable)
public CcApiContextQuery.Builder propertyMatch(Map<String,? extends Object> propertyMatch)

Sets the value of CcApiContextQuery.getPropertyMatch()

Parameters:

propertyMatch - This indicates the property to search for. If both exactIdentifier and propertyMatch are specified, then exactIdentifier is used. Specifying propertyMatch will return 0 or more results. Either exactIdentifier or propertyMatch should be specified.

Returns:

this

account

@Stability(Stable)
public CcApiContextQuery.Builder account(String account)

Sets the value of ContextLookupRoleOptions.getAccount()

Parameters:

account - Query account. This parameter is required.

Returns:

this

region

@Stability(Stable)
public CcApiContextQuery.Builder region(String region)

Sets the value of ContextLookupRoleOptions.getRegion()

Parameters:

region - Query region. This parameter is required.

Returns:

this

assumeRoleAdditionalOptions

@Stability(Stable)
public CcApiContextQuery.Builder assumeRoleAdditionalOptions(Map<String,? extends Object> assumeRoleAdditionalOptions)

Sets the value of ContextLookupRoleOptions.getAssumeRoleAdditionalOptions()

Parameters:

assumeRoleAdditionalOptions - Additional options to pass to STS when assuming the lookup role.

• RoleArn should not be used. Use the dedicated lookupRoleArn property instead.
• ExternalId should not be used. Use the dedicated lookupRoleExternalId instead.

Returns:

this

lookupRoleArn

@Stability(Stable)
public CcApiContextQuery.Builder lookupRoleArn(String lookupRoleArn)

Sets the value of ContextLookupRoleOptions.getLookupRoleArn()

Parameters:

lookupRoleArn - The ARN of the role that should be used to look up the missing values.

Returns:

this

lookupRoleExternalId

@Stability(Stable)
public CcApiContextQuery.Builder lookupRoleExternalId(String lookupRoleExternalId)

Sets the value of ContextLookupRoleOptions.getLookupRoleExternalId()

Parameters:

lookupRoleExternalId - The ExternalId that needs to be supplied while assuming this role.

Returns:

this

build

@Stability(Stable)
public CcApiContextQuery build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CcApiContextQuery

Throws:

NullPointerException - if any required attribute was not provided