Class ResolverRuleConfig

NetworkConfig / CentralNetworkServicesConfig / ResolverConfig / (ResolverEndpointConfig) / ResolverRuleConfig

Route 53 resolver rule configuration. Used to define resolver rules.

Example

- name: accelerator-rule
  domainName: example.com
  ruleType: FORWARD
  shareTargets:
    organizationalUnits:
      - Root
  targetIps:
    - ip: 1.1.1.1
  tags: []

Hierarchy

  • ResolverRuleConfig

Implements

Constructors

constructor

Properties

domainName excludedRegions inboundEndpointTarget name ruleType shareTargets tags targetIps

Constructors

constructor

Properties

Readonly domainName

domainName: string = ''

The domain name for the resolver rule.

Readonly excludedRegions

excludedRegions: undefined | ("af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ca-central-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "eu-north-1" | "eu-south-1" | "eu-south-2" | "me-central-1" | "me-south-1" | "sa-east-1" | "us-east-1" | "us-east-2" | "us-west-1" | "us-west-2" | "cn-north-1" | "cn-northwest-1" | "eu-central-2" | "ap-south-2" | "us-gov-west-1" | "us-gov-east-1" | "us-iso-east-1" | "us-iso-west-1" | "us-isob-east-1" | "ap-southeast-4")[] = undefined

Regions to exclude from deployment.

Remarks

Only define this property if creating a SYSTEM rule type. This does not apply to rules of type FORWARD.

Readonly inboundEndpointTarget

inboundEndpointTarget: undefined | string = undefined

The friendly name of an inbound endpoint to target.

Remarks

Use this property to define resolver rules for resolving DNS records across subdomains hosted within the accelerator environment.

Readonly name

name: string = ''

A friendly name for the resolver rule.

Readonly ruleType

ruleType: undefined | "SYSTEM" | "FORWARD" | "RECURSIVE" = 'FORWARD'

The type of rule to create.

See

ruleTypeEnum

Readonly shareTargets

shareTargets: undefined | ShareTargets = undefined

Resource Access Manager (RAM) share targets.

Remarks

Targets can be account names and/or organizational units.

See

t.ShareTargets

Readonly tags

tags: undefined | Tag[] = undefined

An array of tags for the resolve rule.

Readonly targetIps

targetIps: undefined | {
    ip: string;
    port: undefined | string;
}[] = undefined

An array of target IP configurations for the resolver rule.

See

ruleTargetIps

Settings

Member Visibility

Theme

Generated using TypeDoc