Package software.amazon.awscdk.cloud_assembly_schema

Interface CcApiContextQuery

All Superinterfaces:

ContextLookupRoleOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CcApiContextQuery.Jsii$Proxy

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:22.484Z")
@Stability(Stable)
public interface CcApiContextQuery
extends software.amazon.jsii.JsiiSerializable, ContextLookupRoleOptions

Query input for lookup up Cloudformation resources using CC API.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cloud_assembly_schema.*;
 Object assumeRoleAdditionalOptions;
 Object propertyMatch;
 CcApiContextQuery ccApiContextQuery = CcApiContextQuery.builder()
         .account("account")
         .propertiesToReturn(List.of("propertiesToReturn"))
         .region("region")
         .typeName("typeName")
         // the properties below are optional
         .assumeRoleAdditionalOptions(Map.of(
                 "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
         .exactIdentifier("exactIdentifier")
         .lookupRoleArn("lookupRoleArn")
         .lookupRoleExternalId("lookupRoleExternalId")
         .propertyMatch(Map.of(
                 "propertyMatchKey", propertyMatch))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CcApiContextQuery.Builder	A builder for CcApiContextQuery
static final class	CcApiContextQuery.Jsii$Proxy	An implementation for CcApiContextQuery

Method Summary

Modifier and Type	Method	Description
static CcApiContextQuery.Builder	builder()
default String	getExactIdentifier()	exactIdentifier of the resource.
List<String>	getPropertiesToReturn()	This is a set of properties returned from CC API that we want to return from ContextQuery.
default Map<String,Object>	getPropertyMatch()	This indicates the property to search for.
String	getTypeName()	The Cloudformation resource type.

Methods inherited from interface software.amazon.awscdk.cloud_assembly_schema.ContextLookupRoleOptions

getAccount, getAssumeRoleAdditionalOptions, getLookupRoleArn, getLookupRoleExternalId, getRegion

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPropertiesToReturn

@Stability(Stable)
@NotNull
List<String> getPropertiesToReturn()

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

getTypeName

@Stability(Stable)
@NotNull
String getTypeName()

The Cloudformation resource type.

See https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/supported-resources.html

getExactIdentifier

@Stability(Stable)
@Nullable
default String getExactIdentifier()

exactIdentifier of the resource.

Specifying exactIdentifier will return at most one result. Either exactIdentifier or propertyMatch should be specified.

Default: - None

getPropertyMatch

@Stability(Stable)
@Nullable
default Map<String,Object> getPropertyMatch()

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.

Default: - None

builder

@Stability(Stable)
static CcApiContextQuery.Builder builder()

Returns:

a CcApiContextQuery.Builder of CcApiContextQuery