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 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. If any properties listed here are absent from the target resource, an error will be thrown.

      The returned object will always include the key Identifier with the CC-API returned field Identifier.

      Notes on property completeness

      CloudControl API's ListResources may return fewer properties than GetResource would, depending on the resource implementation.

      The returned properties here are currently selected from the response object that CloudControl API returns to the CDK CLI.

      However, if we find there is need to do so, we may decide to change this behavior in the future: we might change it to perform an additional GetResource call for resources matched by propertyMatch.

      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

    • dummyValue

      @Stability(Stable) public CcApiContextQuery.Builder dummyValue(Object dummyValue)
      Sets the value of CcApiContextQuery.getDummyValue()
      Parameters:
      dummyValue - The value to return if the resource was not found and ignoreErrorOnMissingContext is true. If supplied, dummyValue should be an array of objects.

      dummyValue does not have to have elements, and it may have objects with different properties than the properties in propertiesToReturn, but it will be easiest for downstream code if the dummyValue conforms to the expected response shape.

      Returns:
      this

    • exactIdentifier

      @Stability(Stable) public CcApiContextQuery.Builder exactIdentifier(String exactIdentifier)
      Sets the value of CcApiContextQuery.getExactIdentifier()
      Parameters:
      exactIdentifier - Identifier of the resource to look up using GetResource. Specifying exactIdentifier will return exactly one result, or throw an error unless ignoreErrorOnMissingContext is set.
      Returns:
      this

    • expectedMatchCount

      @Stability(Stable) public CcApiContextQuery.Builder expectedMatchCount(String expectedMatchCount)
      Sets the value of CcApiContextQuery.getExpectedMatchCount()
      Parameters:
      expectedMatchCount - Expected count of results if propertyMatch is specified. If the expected result count does not match the actual count, by default an error is produced and the result is not committed to cached context, and the user can correct the situation and try again without having to manually clear out the context key using cdk context --remove

      If the value of * ignoreErrorOnMissingContext is true, the value of expectedMatchCount is at-least-one | exactly-one and the number of found resources is 0, dummyValue is returned and committed to context instead.

      Returns:
      this

    • ignoreErrorOnMissingContext

      @Stability(Stable) public CcApiContextQuery.Builder ignoreErrorOnMissingContext(Boolean ignoreErrorOnMissingContext)
      Sets the value of CcApiContextQuery.getIgnoreErrorOnMissingContext()
      Parameters:
      ignoreErrorOnMissingContext - Ignore an error and return the dummyValue instead if the resource was not found.
      • In case of an exactIdentifier lookup, return the dummyValue if the resource with that identifier was not found.
      • In case of a propertyMatch lookup, return the dummyValue if expectedMatchCount is at-least-one | exactly-one and the number of resources found was 0.

      if ignoreErrorOnMissingContext is set, dummyValue should be set and be an array.

      Returns:
      this

    • propertyMatch

      @Stability(Stable) public CcApiContextQuery.Builder propertyMatch(Map<String,? extends Object> propertyMatch)
      Sets the value of CcApiContextQuery.getPropertyMatch()
      Parameters:
      propertyMatch - Returns any resources matching these properties, using ListResources. By default, specifying propertyMatch will successfully return 0 or more results. To throw an error if the number of results is unexpected (and prevent the query results from being committed to context), specify expectedMatchCount.

      Notes on property completeness

      CloudControl API's ListResources may return fewer properties than GetResource would, depending on the resource implementation.

      The resources that propertyMatch matches against will only ever be the properties returned by the ListResources call.

      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