Interface HostedZoneContextQuery

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
HostedZoneContextQuery.Jsii$Proxy

@Generated(value="jsii-pacmak/1.95.0 (build f1ff514)", date="2024-03-26T18:09:32.184Z") @Stability(Stable) public interface HostedZoneContextQuery extends software.amazon.jsii.JsiiSerializable
Query to hosted zone context provider.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cloudassembly.schema.*;
 HostedZoneContextQuery hostedZoneContextQuery = HostedZoneContextQuery.builder()
         .account("account")
         .domainName("domainName")
         .region("region")
         // the properties below are optional
         .lookupRoleArn("lookupRoleArn")
         .privateZone(false)
         .vpcId("vpcId")
         .build();
 
  • Method Details

    • getAccount

      @Stability(Stable) @NotNull String getAccount()
      Query account.
    • getDomainName

      @Stability(Stable) @NotNull String getDomainName()
      The domain name e.g. example.com to lookup.
    • getRegion

      @Stability(Stable) @NotNull String getRegion()
      Query region.
    • getLookupRoleArn

      @Stability(Stable) @Nullable default String getLookupRoleArn()
      The ARN of the role that should be used to look up the missing values.

      Default: - None

    • getPrivateZone

      @Stability(Stable) @Nullable default Boolean getPrivateZone()
      True if the zone you want to find is a private hosted zone.

      Default: false

    • getVpcId

      @Stability(Stable) @Nullable default String getVpcId()
      The VPC ID to that the private zone must be associated with.

      If you provide VPC ID and privateZone is false, this will return no results and raise an error.

      Default: - Required if privateZone=true

    • builder

      @Stability(Stable) static HostedZoneContextQuery.Builder builder()
      Returns:
      a HostedZoneContextQuery.Builder of HostedZoneContextQuery