Package software.amazon.awscdk.cloudassembly.schema

Class CcApiContextQuery.Jsii$Proxy

    • Constructor Detail

      • Jsii$Proxy

        protected Jsii$Proxy​(software.amazon.jsii.JsiiObjectRef objRef)
        Constructor that initializes the object based on values retrieved from the JsiiObject.
        Parameters:
        objRef - Reference to the JSII managed object.

    • Method Detail

      • getPropertiesToReturn

        public final List<String> getPropertiesToReturn()
        Description copied from interface: CcApiContextQuery
        This is a set of properties returned from CC API that we want to return from ContextQuery.

        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.

        Specified by:
        getPropertiesToReturn in interface CcApiContextQuery

      • getTypeName

        public final String getTypeName()
        Description copied from interface: CcApiContextQuery
        The CloudFormation resource type.

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

        Specified by:
        getTypeName in interface CcApiContextQuery

      • getDummyValue

        public final Object getDummyValue()
        Description copied from interface: CcApiContextQuery
        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.

        Default: - No dummy value available

        Specified by:
        getDummyValue in interface CcApiContextQuery

      • getExactIdentifier

        public final String getExactIdentifier()
        Description copied from interface: CcApiContextQuery
        Identifier of the resource to look up using GetResource.

        Specifying exactIdentifier will return exactly one result, or throw an error unless ignoreErrorOnMissingContext is set.

        Default: - Either exactIdentifier or propertyMatch should be specified.

        Specified by:
        getExactIdentifier in interface CcApiContextQuery

      • getExpectedMatchCount

        public final String getExpectedMatchCount()
        Description copied from interface: CcApiContextQuery
        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.

        Default: 'any'

        Specified by:
        getExpectedMatchCount in interface CcApiContextQuery

      • getIgnoreErrorOnMissingContext

        public final Boolean getIgnoreErrorOnMissingContext()
        Description copied from interface: CcApiContextQuery
        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.

        Default: false

        Specified by:
        getIgnoreErrorOnMissingContext in interface CcApiContextQuery

      • getPropertyMatch

        public final Map<String,​Object> getPropertyMatch()
        Description copied from interface: CcApiContextQuery
        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.

        Default: - Either exactIdentifier or propertyMatch should be specified.

        Specified by:
        getPropertyMatch in interface CcApiContextQuery

      • $jsii$toJson

        @Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
        Specified by:
        $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object