{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/aws-ec2": "1.64.0", "@aws-cdk/aws-logs": "1.64.0", "@aws-cdk/cloud-assembly-schema": "1.64.0", "@aws-cdk/core": "1.64.0", "constructs": "^3.0.4" }, "dependencyClosure": { "@aws-cdk/assets": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.Assets", "packageId": "Amazon.CDK.Assets", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.assets" }, "js": { "npm": "@aws-cdk/assets" }, "python": { "distName": "aws-cdk.assets", "module": "aws_cdk.assets" } } }, "@aws-cdk/aws-cloudwatch": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CloudWatch", "packageId": "Amazon.CDK.AWS.CloudWatch", "signAssembly": true }, "java": { "maven": { "artifactId": "cloudwatch", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.cloudwatch" }, "js": { "npm": "@aws-cdk/aws-cloudwatch" }, "python": { "distName": "aws-cdk.aws-cloudwatch", "module": "aws_cdk.aws_cloudwatch" } } }, "@aws-cdk/aws-ec2": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.EC2", "packageId": "Amazon.CDK.AWS.EC2", "signAssembly": true }, "java": { "maven": { "artifactId": "ec2", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ec2" }, "js": { "npm": "@aws-cdk/aws-ec2" }, "python": { "distName": "aws-cdk.aws-ec2", "module": "aws_cdk.aws_ec2" } } }, "@aws-cdk/aws-events": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Events", "packageId": "Amazon.CDK.AWS.Events", "signAssembly": true }, "java": { "maven": { "artifactId": "events", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.events" }, "js": { "npm": "@aws-cdk/aws-events" }, "python": { "distName": "aws-cdk.aws-events", "module": "aws_cdk.aws_events" } } }, "@aws-cdk/aws-iam": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.IAM", "packageId": "Amazon.CDK.AWS.IAM", "signAssembly": true }, "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" }, "python": { "distName": "aws-cdk.aws-iam", "module": "aws_cdk.aws_iam" } } }, "@aws-cdk/aws-kms": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.KMS", "packageId": "Amazon.CDK.AWS.KMS", "signAssembly": true }, "java": { "maven": { "artifactId": "kms", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.kms" }, "js": { "npm": "@aws-cdk/aws-kms" }, "python": { "distName": "aws-cdk.aws-kms", "module": "aws_cdk.aws_kms" } } }, "@aws-cdk/aws-logs": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Logs", "packageId": "Amazon.CDK.AWS.Logs", "signAssembly": true }, "java": { "maven": { "artifactId": "logs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.logs" }, "js": { "npm": "@aws-cdk/aws-logs" }, "python": { "distName": "aws-cdk.aws-logs", "module": "aws_cdk.aws_logs" } } }, "@aws-cdk/aws-s3": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3", "packageId": "Amazon.CDK.AWS.S3", "signAssembly": true }, "java": { "maven": { "artifactId": "s3", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3" }, "js": { "npm": "@aws-cdk/aws-s3" }, "python": { "distName": "aws-cdk.aws-s3", "module": "aws_cdk.aws_s3" } } }, "@aws-cdk/aws-s3-assets": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3.Assets", "packageId": "Amazon.CDK.AWS.S3.Assets", "signAssembly": true }, "java": { "maven": { "artifactId": "s3-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3.assets" }, "js": { "npm": "@aws-cdk/aws-s3-assets" }, "python": { "distName": "aws-cdk.aws-s3-assets", "module": "aws_cdk.aws_s3_assets" } } }, "@aws-cdk/aws-ssm": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SSM", "packageId": "Amazon.CDK.AWS.SSM", "signAssembly": true }, "java": { "maven": { "artifactId": "ssm", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ssm" }, "js": { "npm": "@aws-cdk/aws-ssm" }, "python": { "distName": "aws-cdk.aws-ssm", "module": "aws_cdk.aws_ssm" } } }, "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-cloud-assembly-schema", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cloudassembly.schema" }, "js": { "npm": "@aws-cdk/cloud-assembly-schema" }, "python": { "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK", "signAssembly": true }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "The CDK Construct Library for AWS::Route53", "docs": { "stability": "stable" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.12.0 (build 5ddc9f2)", "keywords": [ "aws", "cdk", "constructs", "route53" ], "license": "Apache-2.0", "name": "@aws-cdk/aws-route53", "readme": { "markdown": "## Amazon Route53 Construct Library\n\n---\n\n![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)\n\n![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)\n\n---\n\n\nTo add a public hosted zone:\n\n```ts\nimport * as route53 from '@aws-cdk/aws-route53';\n\nnew route53.PublicHostedZone(this, 'HostedZone', {\n zoneName: 'fully.qualified.domain.com'\n});\n```\n\nTo add a private hosted zone, use `PrivateHostedZone`. Note that\n`enableDnsHostnames` and `enableDnsSupport` must have been enabled for the\nVPC you're configuring for private hosted zones.\n\n```ts\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as route53 from '@aws-cdk/aws-route53';\n\nconst vpc = new ec2.Vpc(this, 'VPC');\n\nconst zone = new route53.PrivateHostedZone(this, 'HostedZone', {\n zoneName: 'fully.qualified.domain.com',\n vpc // At least one VPC has to be added to a Private Hosted Zone.\n});\n```\n\nAdditional VPCs can be added with `zone.addVpc()`.\n\n### Adding Records\n\nTo add a TXT record to your zone:\n```ts\nimport * as route53 from '@aws-cdk/aws-route53';\n\nnew route53.TxtRecord(this, 'TXTRecord', {\n zone: myZone,\n recordName: '_foo', // If the name ends with a \".\", it will be used as-is;\n // if it ends with a \".\" followed by the zone name, a trailing \".\" will be added automatically;\n // otherwise, a \".\", the zone name, and a trailing \".\" will be added automatically.\n // Defaults to zone root if not specified.\n values: [ // Will be quoted for you, and \" will be escaped automatically.\n 'Bar!',\n 'Baz?'\n ],\n ttl: Duration.minutes(90), // Optional - default is 30 minutes\n});\n```\n\nTo add a A record to your zone:\n```ts\nimport * as route53 from '@aws-cdk/aws-route53';\n\nnew route53.ARecord(this, 'ARecord', {\n zone: myZone,\n target: route53.RecordTarget.fromIpAddresses('1.2.3.4', '5.6.7.8')\n});\n```\n\nTo add a AAAA record pointing to a CloudFront distribution:\n```ts\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as targets from '@aws-cdk/aws-route53-targets';\n\nnew route53.AaaaRecord(this, 'Alias', {\n zone: myZone,\n target: route53.RecordTarget.fromAlias(new targets.CloudFrontTarget(distribution))\n});\n```\n\nConstructs are available for A, AAAA, CAA, CNAME, MX, NS, SRV and TXT records.\n\nUse the `CaaAmazonRecord` construct to easily restrict certificate authorities\nallowed to issue certificates for a domain to Amazon only.\n\n### Imports\n\nIf you don't know the ID of the Hosted Zone to import, you can use the\n`HostedZone.fromLookup`:\n\n```ts\nHostedZone.fromLookup(this, 'MyZone', {\n domainName: 'example.com'\n});\n```\n\n`HostedZone.fromLookup` requires an environment to be configured. Check\nout the [documentation](https://docs.aws.amazon.com/cdk/latest/guide/environments.html) for more documentation and examples. CDK\nautomatically looks into your `~/.aws/config` file for the `[default]` profile.\nIf you want to specify a different account run `cdk deploy --profile [profile]`.\n\n```ts\nnew MyDevStack(app, 'dev', {\n env: {\n account: process.env.CDK_DEFAULT_ACCOUNT,\n region: process.env.CDK_DEFAULT_REGION\n}});\n```\n\nIf you know the ID and Name of a Hosted Zone, you can import it directly:\n\n```ts\nconst zone = HostedZone.fromHostedZoneAttributes(this, 'MyZone', {\n zoneName: 'example.com',\n hostedZoneId: 'ZOJJZC49E0EPZ',\n});\n```\n\nAlternatively, use the `HostedZone.fromHostedZoneId` to import hosted zones if\nyou know the ID and the retrieval for the `zoneName` is undesirable.\n\n```ts\nconst zone = HostedZone.fromHostedZoneId(this, 'MyZone', {\n hostedZoneId: 'ZOJJZC49E0EPZ',\n});\n```" }, "repository": { "directory": "packages/@aws-cdk/aws-route53", "type": "git", "url": "https://github.com/aws/aws-cdk.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Route53", "packageId": "Amazon.CDK.AWS.Route53", "signAssembly": true }, "java": { "maven": { "artifactId": "route53", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.route53" }, "js": { "npm": "@aws-cdk/aws-route53" }, "python": { "distName": "aws-cdk.aws-route53", "module": "aws_cdk.aws_route53" } }, "types": { "@aws-cdk/aws-route53.ARecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet" }, "stability": "stable", "summary": "A DNS A record." }, "fqn": "@aws-cdk/aws-route53.ARecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 246 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.ARecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 245 }, "name": "ARecord" }, "@aws-cdk/aws-route53.ARecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a ARecord." }, "fqn": "@aws-cdk/aws-route53.ARecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 233 }, "name": "ARecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The target." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 237 }, "name": "target", "type": { "fqn": "@aws-cdk/aws-route53.RecordTarget" } } ] }, "@aws-cdk/aws-route53.AaaaRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet" }, "stability": "stable", "summary": "A DNS AAAA record." }, "fqn": "@aws-cdk/aws-route53.AaaaRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 271 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.AaaaRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 270 }, "name": "AaaaRecord" }, "@aws-cdk/aws-route53.AaaaRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a AaaaRecord." }, "fqn": "@aws-cdk/aws-route53.AaaaRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 258 }, "name": "AaaaRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The target." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 262 }, "name": "target", "type": { "fqn": "@aws-cdk/aws-route53.RecordTarget" } } ] }, "@aws-cdk/aws-route53.AddressRecordTarget": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordTarget", "docs": { "deprecated": "Use RecordTarget", "stability": "deprecated", "summary": "Target for a DNS A Record." }, "fqn": "@aws-cdk/aws-route53.AddressRecordTarget", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 177 }, "parameters": [ { "docs": { "summary": "correspond with the chosen record type (e.g. for 'A' Type, specify one ore more IP addresses)." }, "name": "values", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "summary": "alias for targets such as CloudFront distribution to route traffic to." }, "name": "aliasTarget", "optional": true, "type": { "fqn": "@aws-cdk/aws-route53.IAliasRecordTarget" } } ], "protected": true }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 227 }, "name": "AddressRecordTarget" }, "@aws-cdk/aws-route53.AliasRecordTargetConfig": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Represents the properties of an alias target destination." }, "fqn": "@aws-cdk/aws-route53.AliasRecordTargetConfig", "kind": "interface", "locationInModule": { "filename": "lib/alias-record-target.ts", "line": 17 }, "name": "AliasRecordTargetConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "DNS name of the target." }, "immutable": true, "locationInModule": { "filename": "lib/alias-record-target.ts", "line": 26 }, "name": "dnsName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Hosted zone ID of the target." }, "immutable": true, "locationInModule": { "filename": "lib/alias-record-target.ts", "line": 21 }, "name": "hostedZoneId", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.CaaAmazonRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.CaaRecord", "docs": { "custom": { "resource": "AWS::Route53::RecordSet" }, "remarks": "A CAA record to restrict certificate authorities allowed\nto issue certificates for a domain to Amazon only.", "stability": "stable", "summary": "A DNS Amazon CAA record." }, "fqn": "@aws-cdk/aws-route53.CaaAmazonRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 481 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.CaaAmazonRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 480 }, "name": "CaaAmazonRecord" }, "@aws-cdk/aws-route53.CaaAmazonRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a CaaAmazonRecord." }, "fqn": "@aws-cdk/aws-route53.CaaAmazonRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 470 }, "name": "CaaAmazonRecordProps" }, "@aws-cdk/aws-route53.CaaRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet" }, "stability": "stable", "summary": "A DNS CAA record." }, "fqn": "@aws-cdk/aws-route53.CaaRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 458 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.CaaRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 457 }, "name": "CaaRecord" }, "@aws-cdk/aws-route53.CaaRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a CaaRecord." }, "fqn": "@aws-cdk/aws-route53.CaaRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 445 }, "name": "CaaRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The values." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 449 }, "name": "values", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-route53.CaaRecordValue" }, "kind": "array" } } } ] }, "@aws-cdk/aws-route53.CaaRecordValue": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a CAA record value." }, "fqn": "@aws-cdk/aws-route53.CaaRecordValue", "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 425 }, "name": "CaaRecordValue", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The flag." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 429 }, "name": "flag", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The tag." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 434 }, "name": "tag", "type": { "fqn": "@aws-cdk/aws-route53.CaaTag" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The value associated with the tag." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 439 }, "name": "value", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.CaaTag": { "assembly": "@aws-cdk/aws-route53", "docs": { "stability": "stable", "summary": "The CAA tag." }, "fqn": "@aws-cdk/aws-route53.CaaTag", "kind": "enum", "locationInModule": { "filename": "lib/record-set.ts", "line": 402 }, "members": [ { "docs": { "stability": "stable", "summary": "Explicity authorizes a single certificate authority to issue a certificate (any type) for the hostname." }, "name": "ISSUE" }, { "docs": { "stability": "stable", "summary": "Explicity authorizes a single certificate authority to issue a wildcard certificate (and only wildcard) for the hostname." }, "name": "ISSUEWILD" }, { "docs": { "stability": "stable", "summary": "Specifies a URL to which a certificate authority may report policy violations." }, "name": "IODEF" } ], "name": "CaaTag" }, "@aws-cdk/aws-route53.CfnHealthCheck": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Route53::HealthCheck" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html", "stability": "external", "summary": "A CloudFormation `AWS::Route53::HealthCheck`." }, "fqn": "@aws-cdk/aws-route53.CfnHealthCheck", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Route53::HealthCheck`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 127 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.CfnHealthCheckProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 81 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 143 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 154 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnHealthCheck", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 85 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "HealthCheckId" }, "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 106 }, "name": "attrHealthCheckId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 148 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig", "stability": "external", "summary": "`AWS::Route53::HealthCheck.HealthCheckConfig`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 112 }, "name": "healthCheckConfig", "type": { "primitive": "any" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags", "stability": "external", "summary": "`AWS::Route53::HealthCheck.HealthCheckTags`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 118 }, "name": "healthCheckTags", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHealthCheck.HealthCheckTagProperty" } ] } }, "kind": "array" } } ] } } } ] }, "@aws-cdk/aws-route53.CfnHealthCheck.HealthCheckTagProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html", "stability": "external" }, "fqn": "@aws-cdk/aws-route53.CfnHealthCheck.HealthCheckTagProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 164 }, "name": "HealthCheckTagProperty", "namespace": "CfnHealthCheck", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthcheck-healthchecktag-key", "stability": "external", "summary": "`CfnHealthCheck.HealthCheckTagProperty.Key`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 169 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthcheck-healthchecktag-value", "stability": "external", "summary": "`CfnHealthCheck.HealthCheckTagProperty.Value`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 174 }, "name": "value", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.CfnHealthCheckProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html", "stability": "external", "summary": "Properties for defining a `AWS::Route53::HealthCheck`." }, "fqn": "@aws-cdk/aws-route53.CfnHealthCheckProps", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 17 }, "name": "CfnHealthCheckProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig", "stability": "external", "summary": "`AWS::Route53::HealthCheck.HealthCheckConfig`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 23 }, "name": "healthCheckConfig", "type": { "primitive": "any" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags", "stability": "external", "summary": "`AWS::Route53::HealthCheck.HealthCheckTags`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 29 }, "name": "healthCheckTags", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHealthCheck.HealthCheckTagProperty" } ] } }, "kind": "array" } } ] } } } ] }, "@aws-cdk/aws-route53.CfnHostedZone": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Route53::HostedZone" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html", "stability": "external", "summary": "A CloudFormation `AWS::Route53::HostedZone`." }, "fqn": "@aws-cdk/aws-route53.CfnHostedZone", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Route53::HostedZone`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 385 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.CfnHostedZoneProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 321 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 404 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 418 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnHostedZone", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 325 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "NameServers" }, "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 346 }, "name": "attrNameServers", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 409 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzonetags", "stability": "external", "summary": "`AWS::Route53::HostedZone.HostedZoneTags`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 364 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-name", "stability": "external", "summary": "`AWS::Route53::HostedZone.Name`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 352 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzoneconfig", "stability": "external", "summary": "`AWS::Route53::HostedZone.HostedZoneConfig`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 358 }, "name": "hostedZoneConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.HostedZoneConfigProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-queryloggingconfig", "stability": "external", "summary": "`AWS::Route53::HostedZone.QueryLoggingConfig`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 370 }, "name": "queryLoggingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.QueryLoggingConfigProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-vpcs", "stability": "external", "summary": "`AWS::Route53::HostedZone.VPCs`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 376 }, "name": "vpcs", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.VPCProperty" } ] } }, "kind": "array" } } ] } } } ] }, "@aws-cdk/aws-route53.CfnHostedZone.HostedZoneConfigProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzoneconfig.html", "stability": "external" }, "fqn": "@aws-cdk/aws-route53.CfnHostedZone.HostedZoneConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 428 }, "name": "HostedZoneConfigProperty", "namespace": "CfnHostedZone", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzoneconfig.html#cfn-route53-hostedzone-hostedzoneconfig-comment", "stability": "external", "summary": "`CfnHostedZone.HostedZoneConfigProperty.Comment`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 433 }, "name": "comment", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.CfnHostedZone.HostedZoneTagProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetags.html", "stability": "external" }, "fqn": "@aws-cdk/aws-route53.CfnHostedZone.HostedZoneTagProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 483 }, "name": "HostedZoneTagProperty", "namespace": "CfnHostedZone", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetags.html#cfn-route53-hostedzonetags-key", "stability": "external", "summary": "`CfnHostedZone.HostedZoneTagProperty.Key`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 488 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetags.html#cfn-route53-hostedzonetags-value", "stability": "external", "summary": "`CfnHostedZone.HostedZoneTagProperty.Value`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 493 }, "name": "value", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.CfnHostedZone.QueryLoggingConfigProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-queryloggingconfig.html", "stability": "external" }, "fqn": "@aws-cdk/aws-route53.CfnHostedZone.QueryLoggingConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 548 }, "name": "QueryLoggingConfigProperty", "namespace": "CfnHostedZone", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-queryloggingconfig.html#cfn-route53-hostedzone-queryloggingconfig-cloudwatchlogsloggrouparn", "stability": "external", "summary": "`CfnHostedZone.QueryLoggingConfigProperty.CloudWatchLogsLogGroupArn`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 553 }, "name": "cloudWatchLogsLogGroupArn", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.CfnHostedZone.VPCProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone-hostedzonevpcs.html", "stability": "external" }, "fqn": "@aws-cdk/aws-route53.CfnHostedZone.VPCProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 604 }, "name": "VPCProperty", "namespace": "CfnHostedZone", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone-hostedzonevpcs.html#cfn-route53-hostedzone-hostedzonevpcs-vpcid", "stability": "external", "summary": "`CfnHostedZone.VPCProperty.VPCId`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 609 }, "name": "vpcId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone-hostedzonevpcs.html#cfn-route53-hostedzone-hostedzonevpcs-vpcregion", "stability": "external", "summary": "`CfnHostedZone.VPCProperty.VPCRegion`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 614 }, "name": "vpcRegion", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.CfnHostedZoneProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html", "stability": "external", "summary": "Properties for defining a `AWS::Route53::HostedZone`." }, "fqn": "@aws-cdk/aws-route53.CfnHostedZoneProps", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 230 }, "name": "CfnHostedZoneProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-name", "stability": "external", "summary": "`AWS::Route53::HostedZone.Name`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 236 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzoneconfig", "stability": "external", "summary": "`AWS::Route53::HostedZone.HostedZoneConfig`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 242 }, "name": "hostedZoneConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.HostedZoneConfigProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzonetags", "stability": "external", "summary": "`AWS::Route53::HostedZone.HostedZoneTags`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 248 }, "name": "hostedZoneTags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.HostedZoneTagProperty" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-queryloggingconfig", "stability": "external", "summary": "`AWS::Route53::HostedZone.QueryLoggingConfig`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 254 }, "name": "queryLoggingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.QueryLoggingConfigProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-vpcs", "stability": "external", "summary": "`AWS::Route53::HostedZone.VPCs`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 260 }, "name": "vpcs", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.VPCProperty" } ] } }, "kind": "array" } } ] } } } ] }, "@aws-cdk/aws-route53.CfnRecordSet": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Route53::RecordSet" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html", "stability": "external", "summary": "A CloudFormation `AWS::Route53::RecordSet`." }, "fqn": "@aws-cdk/aws-route53.CfnRecordSet", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Route53::RecordSet`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 971 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.CfnRecordSetProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 852 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1000 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1024 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnRecordSet", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 856 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1005 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name", "stability": "external", "summary": "`AWS::Route53::RecordSet.Name`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 878 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type", "stability": "external", "summary": "`AWS::Route53::RecordSet.Type`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 884 }, "name": "type", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget", "stability": "external", "summary": "`AWS::Route53::RecordSet.AliasTarget`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 890 }, "name": "aliasTarget", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSet.AliasTargetProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-comment", "stability": "external", "summary": "`AWS::Route53::RecordSet.Comment`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 896 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover", "stability": "external", "summary": "`AWS::Route53::RecordSet.Failover`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 902 }, "name": "failover", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation", "stability": "external", "summary": "`AWS::Route53::RecordSet.GeoLocation`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 908 }, "name": "geoLocation", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSet.GeoLocationProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid", "stability": "external", "summary": "`AWS::Route53::RecordSet.HealthCheckId`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 914 }, "name": "healthCheckId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid", "stability": "external", "summary": "`AWS::Route53::RecordSet.HostedZoneId`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 920 }, "name": "hostedZoneId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename", "stability": "external", "summary": "`AWS::Route53::RecordSet.HostedZoneName`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 926 }, "name": "hostedZoneName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer", "stability": "external", "summary": "`AWS::Route53::RecordSet.MultiValueAnswer`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 932 }, "name": "multiValueAnswer", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region", "stability": "external", "summary": "`AWS::Route53::RecordSet.Region`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 938 }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords", "stability": "external", "summary": "`AWS::Route53::RecordSet.ResourceRecords`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 944 }, "name": "resourceRecords", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier", "stability": "external", "summary": "`AWS::Route53::RecordSet.SetIdentifier`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 950 }, "name": "setIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl", "stability": "external", "summary": "`AWS::Route53::RecordSet.TTL`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 956 }, "name": "ttl", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight", "stability": "external", "summary": "`AWS::Route53::RecordSet.Weight`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 962 }, "name": "weight", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-route53.CfnRecordSet.AliasTargetProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html", "stability": "external" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSet.AliasTargetProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1034 }, "name": "AliasTargetProperty", "namespace": "CfnRecordSet", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname", "stability": "external", "summary": "`CfnRecordSet.AliasTargetProperty.DNSName`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1039 }, "name": "dnsName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid", "stability": "external", "summary": "`CfnRecordSet.AliasTargetProperty.HostedZoneId`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1049 }, "name": "hostedZoneId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth", "stability": "external", "summary": "`CfnRecordSet.AliasTargetProperty.EvaluateTargetHealth`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1044 }, "name": "evaluateTargetHealth", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ] }, "@aws-cdk/aws-route53.CfnRecordSet.GeoLocationProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html", "stability": "external" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSet.GeoLocationProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1107 }, "name": "GeoLocationProperty", "namespace": "CfnRecordSet", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-continentcode", "stability": "external", "summary": "`CfnRecordSet.GeoLocationProperty.ContinentCode`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1112 }, "name": "continentCode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode", "stability": "external", "summary": "`CfnRecordSet.GeoLocationProperty.CountryCode`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1117 }, "name": "countryCode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode", "stability": "external", "summary": "`CfnRecordSet.GeoLocationProperty.SubdivisionCode`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1122 }, "name": "subdivisionCode", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.CfnRecordSetGroup": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Route53::RecordSetGroup" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html", "stability": "external", "summary": "A CloudFormation `AWS::Route53::RecordSetGroup`." }, "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Route53::RecordSetGroup`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1313 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroupProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1260 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1329 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1342 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnRecordSetGroup", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1264 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1334 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-comment", "stability": "external", "summary": "`AWS::Route53::RecordSetGroup.Comment`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1286 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzoneid", "stability": "external", "summary": "`AWS::Route53::RecordSetGroup.HostedZoneId`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1292 }, "name": "hostedZoneId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzonename", "stability": "external", "summary": "`AWS::Route53::RecordSetGroup.HostedZoneName`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1298 }, "name": "hostedZoneName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-recordsets", "stability": "external", "summary": "`AWS::Route53::RecordSetGroup.RecordSets`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1304 }, "name": "recordSets", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup.RecordSetProperty" } ] } }, "kind": "array" } } ] } } } ] }, "@aws-cdk/aws-route53.CfnRecordSetGroup.AliasTargetProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html", "stability": "external" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup.AliasTargetProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1352 }, "name": "AliasTargetProperty", "namespace": "CfnRecordSetGroup", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname", "stability": "external", "summary": "`CfnRecordSetGroup.AliasTargetProperty.DNSName`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1357 }, "name": "dnsName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid", "stability": "external", "summary": "`CfnRecordSetGroup.AliasTargetProperty.HostedZoneId`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1367 }, "name": "hostedZoneId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth", "stability": "external", "summary": "`CfnRecordSetGroup.AliasTargetProperty.EvaluateTargetHealth`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1362 }, "name": "evaluateTargetHealth", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ] }, "@aws-cdk/aws-route53.CfnRecordSetGroup.GeoLocationProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html", "stability": "external" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup.GeoLocationProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1425 }, "name": "GeoLocationProperty", "namespace": "CfnRecordSetGroup", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordsetgroup-geolocation-continentcode", "stability": "external", "summary": "`CfnRecordSetGroup.GeoLocationProperty.ContinentCode`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1430 }, "name": "continentCode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode", "stability": "external", "summary": "`CfnRecordSetGroup.GeoLocationProperty.CountryCode`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1435 }, "name": "countryCode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode", "stability": "external", "summary": "`CfnRecordSetGroup.GeoLocationProperty.SubdivisionCode`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1440 }, "name": "subdivisionCode", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.CfnRecordSetGroup.RecordSetProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html", "stability": "external" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup.RecordSetProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1496 }, "name": "RecordSetProperty", "namespace": "CfnRecordSetGroup", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.Name`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1541 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.Type`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1566 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.AliasTarget`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1501 }, "name": "aliasTarget", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup.AliasTargetProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-comment", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.Comment`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1506 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.Failover`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1511 }, "name": "failover", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.GeoLocation`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1516 }, "name": "geoLocation", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup.GeoLocationProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.HealthCheckId`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1521 }, "name": "healthCheckId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.HostedZoneId`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1526 }, "name": "hostedZoneId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.HostedZoneName`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1531 }, "name": "hostedZoneName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.MultiValueAnswer`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1536 }, "name": "multiValueAnswer", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.Region`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1546 }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.ResourceRecords`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1551 }, "name": "resourceRecords", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.SetIdentifier`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1556 }, "name": "setIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.TTL`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1561 }, "name": "ttl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight", "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.Weight`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1571 }, "name": "weight", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-route53.CfnRecordSetGroupProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html", "stability": "external", "summary": "Properties for defining a `AWS::Route53::RecordSetGroup`." }, "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1179 }, "name": "CfnRecordSetGroupProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-comment", "stability": "external", "summary": "`AWS::Route53::RecordSetGroup.Comment`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1185 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzoneid", "stability": "external", "summary": "`AWS::Route53::RecordSetGroup.HostedZoneId`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1191 }, "name": "hostedZoneId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzonename", "stability": "external", "summary": "`AWS::Route53::RecordSetGroup.HostedZoneName`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1197 }, "name": "hostedZoneName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-recordsets", "stability": "external", "summary": "`AWS::Route53::RecordSetGroup.RecordSets`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1203 }, "name": "recordSets", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup.RecordSetProperty" } ] } }, "kind": "array" } } ] } } } ] }, "@aws-cdk/aws-route53.CfnRecordSetProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html", "stability": "external", "summary": "Properties for defining a `AWS::Route53::RecordSet`." }, "fqn": "@aws-cdk/aws-route53.CfnRecordSetProps", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 670 }, "name": "CfnRecordSetProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name", "stability": "external", "summary": "`AWS::Route53::RecordSet.Name`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 676 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type", "stability": "external", "summary": "`AWS::Route53::RecordSet.Type`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 682 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget", "stability": "external", "summary": "`AWS::Route53::RecordSet.AliasTarget`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 688 }, "name": "aliasTarget", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSet.AliasTargetProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-comment", "stability": "external", "summary": "`AWS::Route53::RecordSet.Comment`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 694 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover", "stability": "external", "summary": "`AWS::Route53::RecordSet.Failover`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 700 }, "name": "failover", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation", "stability": "external", "summary": "`AWS::Route53::RecordSet.GeoLocation`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 706 }, "name": "geoLocation", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSet.GeoLocationProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid", "stability": "external", "summary": "`AWS::Route53::RecordSet.HealthCheckId`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 712 }, "name": "healthCheckId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid", "stability": "external", "summary": "`AWS::Route53::RecordSet.HostedZoneId`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 718 }, "name": "hostedZoneId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename", "stability": "external", "summary": "`AWS::Route53::RecordSet.HostedZoneName`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 724 }, "name": "hostedZoneName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer", "stability": "external", "summary": "`AWS::Route53::RecordSet.MultiValueAnswer`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 730 }, "name": "multiValueAnswer", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region", "stability": "external", "summary": "`AWS::Route53::RecordSet.Region`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 736 }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords", "stability": "external", "summary": "`AWS::Route53::RecordSet.ResourceRecords`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 742 }, "name": "resourceRecords", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier", "stability": "external", "summary": "`AWS::Route53::RecordSet.SetIdentifier`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 748 }, "name": "setIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl", "stability": "external", "summary": "`AWS::Route53::RecordSet.TTL`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 754 }, "name": "ttl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight", "stability": "external", "summary": "`AWS::Route53::RecordSet.Weight`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 760 }, "name": "weight", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-route53.CnameRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet" }, "stability": "stable", "summary": "A DNS CNAME record." }, "fqn": "@aws-cdk/aws-route53.CnameRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 296 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.CnameRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 295 }, "name": "CnameRecord" }, "@aws-cdk/aws-route53.CnameRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a CnameRecord." }, "fqn": "@aws-cdk/aws-route53.CnameRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 283 }, "name": "CnameRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The domain name." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 287 }, "name": "domainName", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.CommonHostedZoneProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Common properties to create a Route 53 hosted zone." }, "fqn": "@aws-cdk/aws-route53.CommonHostedZoneProps", "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 13 }, "name": "CommonHostedZoneProps", "properties": [ { "abstract": true, "docs": { "remarks": "For resource record types that include a domain\nname, specify a fully qualified domain name.", "stability": "stable", "summary": "The name of the domain." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 18 }, "name": "zoneName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "Any comments that you want to include about the hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 25 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "disabled", "stability": "stable", "summary": "The Amazon Resource Name (ARN) for the log group that you want Amazon Route 53 to send query logs to." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 32 }, "name": "queryLogsLogGroupArn", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.HostedZone": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "summary": "Container for records, and records contain information about how to route traffic for a specific domain, such as example.com and its subdomains (acme.example.com, zenith.example.com)." }, "fqn": "@aws-cdk/aws-route53.HostedZone", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 150 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.HostedZoneProps" } } ] }, "interfaces": [ "@aws-cdk/aws-route53.IHostedZone" ], "kind": "class", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 54 }, "methods": [ { "docs": { "remarks": "Use when both hosted zone ID and hosted zone name are known.", "stability": "stable", "summary": "Imports a hosted zone from another stack." }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 91 }, "name": "fromHostedZoneAttributes", "parameters": [ { "docs": { "summary": "the parent Construct for this Construct." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "the logical name of this Construct." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "the HostedZoneAttributes (hosted zone ID and hosted zone name)." }, "name": "attrs", "type": { "fqn": "@aws-cdk/aws-route53.HostedZoneAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-route53.IHostedZone" } }, "static": true }, { "docs": { "remarks": "Use when hosted zone ID is known. Hosted zone name becomes unavailable through this query.", "stability": "stable", "summary": "Import a Route 53 hosted zone defined either outside the CDK, or in a different CDK stack." }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 68 }, "name": "fromHostedZoneId", "parameters": [ { "docs": { "summary": "the parent Construct for this Construct." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "the logical name of this Construct." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "the ID of the hosted zone to import." }, "name": "hostedZoneId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-route53.IHostedZone" } }, "static": true }, { "docs": { "remarks": "Requires environment, you must specify env for the stack.\n\nUse to easily query hosted zones.", "see": "https://docs.aws.amazon.com/cdk/latest/guide/environments.html", "stability": "stable", "summary": "Lookup a hosted zone in the current account/region based on query parameters." }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 111 }, "name": "fromLookup", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "query", "type": { "fqn": "@aws-cdk/aws-route53.HostedZoneProviderProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-route53.IHostedZone" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Add another VPC to this private hosted zone." }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 176 }, "name": "addVpc", "parameters": [ { "docs": { "summary": "the other VPC to add." }, "name": "vpc", "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } } ] } ], "name": "HostedZone", "properties": [ { "docs": { "stability": "stable", "summary": "ARN of this hosted zone, such as arn:${Partition}:route53:::hostedzone/${Id}." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 55 }, "name": "hostedZoneArn", "overrides": "@aws-cdk/aws-route53.IHostedZone", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "ID of this hosted zone, such as \"Z23ABC4XYZL05B\"." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 141 }, "name": "hostedZoneId", "overrides": "@aws-cdk/aws-route53.IHostedZone", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "VPCs to which this hosted zone will be added." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 148 }, "name": "vpcs", "protected": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.VPCProperty" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "FQDN of this hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 142 }, "name": "zoneName", "overrides": "@aws-cdk/aws-route53.IHostedZone", "type": { "primitive": "string" } }, { "docs": { "remarks": "This attribute will be undefined for private hosted zones or hosted zones imported from another stack.", "stability": "stable", "summary": "Returns the set of name servers for the specific hosted zone. For example: ns1.example.com." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 143 }, "name": "hostedZoneNameServers", "optional": true, "overrides": "@aws-cdk/aws-route53.IHostedZone", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ] }, "@aws-cdk/aws-route53.HostedZoneAttributes": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Reference to a hosted zone." }, "fqn": "@aws-cdk/aws-route53.HostedZoneAttributes", "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone-ref.ts", "line": 40 }, "name": "HostedZoneAttributes", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Identifier of the hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone-ref.ts", "line": 44 }, "name": "hostedZoneId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Name of the hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone-ref.ts", "line": 49 }, "name": "zoneName", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.HostedZoneProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Properties of a new hosted zone." }, "fqn": "@aws-cdk/aws-route53.HostedZoneProps", "interfaces": [ "@aws-cdk/aws-route53.CommonHostedZoneProps" ], "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 38 }, "name": "HostedZoneProps", "properties": [ { "abstract": true, "docs": { "default": "public (no VPCs associated)", "remarks": "When you specify\nthis property, a private hosted zone will be created.\n\nYou can associate additional VPCs to this private zone using `addVpc(vpc)`.", "stability": "stable", "summary": "A VPC that you want to associate with this hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 47 }, "name": "vpcs", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.IVpc" }, "kind": "array" } } } ] }, "@aws-cdk/aws-route53.HostedZoneProviderProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Zone properties for looking up the Hosted Zone." }, "fqn": "@aws-cdk/aws-route53.HostedZoneProviderProps", "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone-provider.ts", "line": 4 }, "name": "HostedZoneProviderProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The zone domain e.g. example.com." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone-provider.ts", "line": 8 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether the zone that is being looked up is a private hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone-provider.ts", "line": 15 }, "name": "privateZone", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- No VPC ID", "remarks": "If a VPC ID is provided and privateZone is false, no results will be returned\nand an error will be raised", "stability": "stable", "summary": "Specifies the ID of the VPC associated with a private hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone-provider.ts", "line": 25 }, "name": "vpcId", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.IAliasRecordTarget": { "assembly": "@aws-cdk/aws-route53", "docs": { "stability": "stable", "summary": "Classes that are valid alias record targets, like CloudFront distributions and load balancers, should implement this interface." }, "fqn": "@aws-cdk/aws-route53.IAliasRecordTarget", "kind": "interface", "locationInModule": { "filename": "lib/alias-record-target.ts", "line": 7 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Return hosted zone ID and DNS name, usable for Route53 alias targets." }, "locationInModule": { "filename": "lib/alias-record-target.ts", "line": 11 }, "name": "bind", "parameters": [ { "name": "record", "type": { "fqn": "@aws-cdk/aws-route53.IRecordSet" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-route53.AliasRecordTargetConfig" } } } ], "name": "IAliasRecordTarget" }, "@aws-cdk/aws-route53.IHostedZone": { "assembly": "@aws-cdk/aws-route53", "docs": { "stability": "stable", "summary": "Imported or created hosted zone." }, "fqn": "@aws-cdk/aws-route53.IHostedZone", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone-ref.ts", "line": 6 }, "name": "IHostedZone", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "ARN of this hosted zone, such as arn:${Partition}:route53:::hostedzone/${Id}." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone-ref.ts", "line": 24 }, "name": "hostedZoneArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "ID of this hosted zone, such as \"Z23ABC4XYZL05B\"." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone-ref.ts", "line": 12 }, "name": "hostedZoneId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "FQDN of this hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone-ref.ts", "line": 17 }, "name": "zoneName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "remarks": "This attribute will be undefined for private hosted zones or hosted zones imported from another stack.", "stability": "stable", "summary": "Returns the set of name servers for the specific hosted zone. For example: ns1.example.com." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone-ref.ts", "line": 34 }, "name": "hostedZoneNameServers", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ] }, "@aws-cdk/aws-route53.IPrivateHostedZone": { "assembly": "@aws-cdk/aws-route53", "docs": { "stability": "stable", "summary": "Represents a Route 53 private hosted zone." }, "fqn": "@aws-cdk/aws-route53.IPrivateHostedZone", "interfaces": [ "@aws-cdk/aws-route53.IHostedZone" ], "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 290 }, "name": "IPrivateHostedZone" }, "@aws-cdk/aws-route53.IPublicHostedZone": { "assembly": "@aws-cdk/aws-route53", "docs": { "stability": "stable", "summary": "Represents a Route 53 public hosted zone." }, "fqn": "@aws-cdk/aws-route53.IPublicHostedZone", "interfaces": [ "@aws-cdk/aws-route53.IHostedZone" ], "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 197 }, "name": "IPublicHostedZone" }, "@aws-cdk/aws-route53.IRecordSet": { "assembly": "@aws-cdk/aws-route53", "docs": { "stability": "stable", "summary": "A record set." }, "fqn": "@aws-cdk/aws-route53.IRecordSet", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 10 }, "name": "IRecordSet", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The domain name of the record." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 14 }, "name": "domainName", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.MxRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet" }, "stability": "stable", "summary": "A DNS MX record." }, "fqn": "@aws-cdk/aws-route53.MxRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 526 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.MxRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 525 }, "name": "MxRecord" }, "@aws-cdk/aws-route53.MxRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a MxRecord." }, "fqn": "@aws-cdk/aws-route53.MxRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 513 }, "name": "MxRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The values." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 517 }, "name": "values", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-route53.MxRecordValue" }, "kind": "array" } } } ] }, "@aws-cdk/aws-route53.MxRecordValue": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a MX record value." }, "fqn": "@aws-cdk/aws-route53.MxRecordValue", "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 498 }, "name": "MxRecordValue", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The mail server host name." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 507 }, "name": "hostName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The priority." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 502 }, "name": "priority", "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-route53.PrivateHostedZone": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.HostedZone", "docs": { "custom": { "resource": "AWS::Route53::HostedZone" }, "remarks": "Note that `enableDnsHostnames` and `enableDnsSupport` must have been enabled\nfor the VPC you're configuring for private hosted zones.", "stability": "stable", "summary": "Create a Route53 private hosted zone for use in one or more VPCs." }, "fqn": "@aws-cdk/aws-route53.PrivateHostedZone", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 320 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.PrivateHostedZoneProps" } } ] }, "interfaces": [ "@aws-cdk/aws-route53.IPrivateHostedZone" ], "kind": "class", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 300 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import a Route 53 private hosted zone defined either outside the CDK, or in a different CDK stack." }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 309 }, "name": "fromPrivateHostedZoneId", "parameters": [ { "docs": { "summary": "the parent Construct for this Construct." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "the logical name of this Construct." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "the ID of the private hosted zone to import." }, "name": "privateHostedZoneId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-route53.IPrivateHostedZone" } }, "static": true } ], "name": "PrivateHostedZone" }, "@aws-cdk/aws-route53.PrivateHostedZoneProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Properties to create a Route 53 private hosted zone." }, "fqn": "@aws-cdk/aws-route53.PrivateHostedZoneProps", "interfaces": [ "@aws-cdk/aws-route53.CommonHostedZoneProps" ], "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 277 }, "name": "PrivateHostedZoneProps", "properties": [ { "abstract": true, "docs": { "remarks": "Private hosted zones must be associated with at least one VPC. You can\nassociated additional VPCs using `addVpc(vpc)`.", "stability": "stable", "summary": "A VPC that you want to associate with this hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 284 }, "name": "vpc", "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } } ] }, "@aws-cdk/aws-route53.PublicHostedZone": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.HostedZone", "docs": { "custom": { "resource": "AWS::Route53::HostedZone" }, "stability": "stable", "summary": "Create a Route53 public hosted zone." }, "fqn": "@aws-cdk/aws-route53.PublicHostedZone", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 224 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.PublicHostedZoneProps" } } ] }, "interfaces": [ "@aws-cdk/aws-route53.IPublicHostedZone" ], "kind": "class", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 204 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import a Route 53 public hosted zone defined either outside the CDK, or in a different CDK stack." }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 213 }, "name": "fromPublicHostedZoneId", "parameters": [ { "docs": { "summary": "the parent Construct for this Construct." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "the logical name of this Construct." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "the ID of the public hosted zone to import." }, "name": "publicHostedZoneId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-route53.IPublicHostedZone" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Adds a delegation from this zone to a designated zone." }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 244 }, "name": "addDelegation", "parameters": [ { "docs": { "summary": "the zone being delegated to." }, "name": "delegate", "type": { "fqn": "@aws-cdk/aws-route53.IPublicHostedZone" } }, { "docs": { "summary": "options for creating the DNS record, if any." }, "name": "opts", "optional": true, "type": { "fqn": "@aws-cdk/aws-route53.ZoneDelegationOptions" } } ] }, { "docs": { "stability": "stable", "summary": "Add another VPC to this private hosted zone." }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 234 }, "name": "addVpc", "overrides": "@aws-cdk/aws-route53.HostedZone", "parameters": [ { "name": "_vpc", "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } } ] } ], "name": "PublicHostedZone" }, "@aws-cdk/aws-route53.PublicHostedZoneProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a PublicHostedZone." }, "fqn": "@aws-cdk/aws-route53.PublicHostedZoneProps", "interfaces": [ "@aws-cdk/aws-route53.CommonHostedZoneProps" ], "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 184 }, "name": "PublicHostedZoneProps", "properties": [ { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether to create a CAA record to restrict certificate authorities allowed to issue certificates for this domain to Amazon only." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 191 }, "name": "caaAmazon", "optional": true, "type": { "primitive": "boolean" } } ] }, "@aws-cdk/aws-route53.RecordSet": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "summary": "A record set." }, "fqn": "@aws-cdk/aws-route53.RecordSet", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 203 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.RecordSetProps" } } ] }, "interfaces": [ "@aws-cdk/aws-route53.IRecordSet" ], "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 200 }, "name": "RecordSet", "properties": [ { "docs": { "stability": "stable", "summary": "The domain name of the record." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 201 }, "name": "domainName", "overrides": "@aws-cdk/aws-route53.IRecordSet", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-route53.RecordSetOptions": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Options for a RecordSet." }, "fqn": "@aws-cdk/aws-route53.RecordSetOptions", "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 119 }, "name": "RecordSetOptions", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The hosted zone in which to define the new record." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 123 }, "name": "zone", "type": { "fqn": "@aws-cdk/aws-route53.IHostedZone" } }, { "abstract": true, "docs": { "default": "no comment", "stability": "stable", "summary": "A comment to add on the record." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 144 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "zone root", "stability": "stable", "summary": "The domain name for this record." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 130 }, "name": "recordName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "Duration.minutes(30)", "stability": "stable", "summary": "The resource record cache time to live (TTL)." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 137 }, "name": "ttl", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } } ] }, "@aws-cdk/aws-route53.RecordSetProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a RecordSet." }, "fqn": "@aws-cdk/aws-route53.RecordSetProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 184 }, "name": "RecordSetProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The record type." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 188 }, "name": "recordType", "type": { "fqn": "@aws-cdk/aws-route53.RecordType" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The target for this record, either `RecordTarget.fromValues()` or `RecordTarget.fromAlias()`." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 194 }, "name": "target", "type": { "fqn": "@aws-cdk/aws-route53.RecordTarget" } } ] }, "@aws-cdk/aws-route53.RecordTarget": { "assembly": "@aws-cdk/aws-route53", "docs": { "stability": "stable", "summary": "Type union for a record that accepts multiple types of target." }, "fqn": "@aws-cdk/aws-route53.RecordTarget", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 177 }, "parameters": [ { "docs": { "summary": "correspond with the chosen record type (e.g. for 'A' Type, specify one ore more IP addresses)." }, "name": "values", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "summary": "alias for targets such as CloudFront distribution to route traffic to." }, "name": "aliasTarget", "optional": true, "type": { "fqn": "@aws-cdk/aws-route53.IAliasRecordTarget" } } ], "protected": true }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 150 }, "methods": [ { "docs": { "stability": "stable", "summary": "Use an alias as target." }, "locationInModule": { "filename": "lib/record-set.ts", "line": 161 }, "name": "fromAlias", "parameters": [ { "name": "aliasTarget", "type": { "fqn": "@aws-cdk/aws-route53.IAliasRecordTarget" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-route53.RecordTarget" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Use ip addresses as target." }, "locationInModule": { "filename": "lib/record-set.ts", "line": 168 }, "name": "fromIpAddresses", "parameters": [ { "name": "ipAddresses", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "@aws-cdk/aws-route53.RecordTarget" } }, "static": true, "variadic": true }, { "docs": { "stability": "stable", "summary": "Use string values as target." }, "locationInModule": { "filename": "lib/record-set.ts", "line": 154 }, "name": "fromValues", "parameters": [ { "name": "values", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "@aws-cdk/aws-route53.RecordTarget" } }, "static": true, "variadic": true } ], "name": "RecordTarget", "properties": [ { "docs": { "stability": "stable", "summary": "alias for targets such as CloudFront distribution to route traffic to." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 177 }, "name": "aliasTarget", "optional": true, "type": { "fqn": "@aws-cdk/aws-route53.IAliasRecordTarget" } }, { "docs": { "stability": "stable", "summary": "correspond with the chosen record type (e.g. for 'A' Type, specify one ore more IP addresses)." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 177 }, "name": "values", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ] }, "@aws-cdk/aws-route53.RecordType": { "assembly": "@aws-cdk/aws-route53", "docs": { "stability": "stable", "summary": "The record type." }, "fqn": "@aws-cdk/aws-route53.RecordType", "kind": "enum", "locationInModule": { "filename": "lib/record-set.ts", "line": 20 }, "members": [ { "docs": { "see": "https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html#AFormat", "stability": "stable", "summary": "route traffic to a resource, such as a web server, using an IPv4 address in dotted decimal notation." }, "name": "A" }, { "docs": { "see": "https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html#AAAAFormat", "stability": "stable", "summary": "route traffic to a resource, such as a web server, using an IPv6 address in colon-separated hexadecimal format." }, "name": "AAAA" }, { "docs": { "see": "https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html#CAAFormat", "stability": "stable", "summary": "A CAA record specifies which certificate authorities (CAs) are allowed to issue certificates for a domain or subdomain." }, "name": "CAA" }, { "docs": { "see": "https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html#CNAMEFormat", "stability": "stable", "summary": "A CNAME record maps DNS queries for the name of the current record, such as acme.example.com, to another domain (example.com or example.net) or subdomain (acme.example.com or zenith.example.org)." }, "name": "CNAME" }, { "docs": { "see": "https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html#MXFormat", "stability": "stable", "summary": "An MX record specifies the names of your mail servers and, if you have two or more mail servers, the priority order." }, "name": "MX" }, { "docs": { "remarks": "For example, one common use is to convert phone numbers into SIP URIs.", "see": "https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html#NAPTRFormat", "stability": "stable", "summary": "A Name Authority Pointer (NAPTR) is a type of record that is used by Dynamic Delegation Discovery System (DDDS) applications to convert one value to another or to replace one value with another." }, "name": "NAPTR" }, { "docs": { "see": "https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html#NSFormat", "stability": "stable", "summary": "An NS record identifies the name servers for the hosted zone." }, "name": "NS" }, { "docs": { "see": "https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html#PTRFormat", "stability": "stable", "summary": "A PTR record maps an IP address to the corresponding domain name." }, "name": "PTR" }, { "docs": { "see": "https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html#SOAFormat", "stability": "stable", "summary": "A start of authority (SOA) record provides information about a domain and the corresponding Amazon Route 53 hosted zone." }, "name": "SOA" }, { "docs": { "remarks": "Instead of an SPF record, we recommend that you create a TXT record that contains the applicable value.", "see": "https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html#SPFFormat", "stability": "stable", "summary": "SPF records were formerly used to verify the identity of the sender of email messages." }, "name": "SPF" }, { "docs": { "remarks": "The first three values are\ndecimal numbers representing priority, weight, and port. The fourth value is a domain name.", "see": "https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html#SRVFormat", "stability": "stable", "summary": "An SRV record Value element consists of four space-separated values." }, "name": "SRV" }, { "docs": { "see": "https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html#TXTFormat", "stability": "stable", "summary": "A TXT record contains one or more strings that are enclosed in double quotation marks (\")." }, "name": "TXT" } ], "name": "RecordType" }, "@aws-cdk/aws-route53.SrvRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet" }, "stability": "stable", "summary": "A DNS SRV record." }, "fqn": "@aws-cdk/aws-route53.SrvRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 390 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.SrvRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 389 }, "name": "SrvRecord" }, "@aws-cdk/aws-route53.SrvRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a SrvRecord." }, "fqn": "@aws-cdk/aws-route53.SrvRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 377 }, "name": "SrvRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The values." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 381 }, "name": "values", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-route53.SrvRecordValue" }, "kind": "array" } } } ] }, "@aws-cdk/aws-route53.SrvRecordValue": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a SRV record value." }, "fqn": "@aws-cdk/aws-route53.SrvRecordValue", "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 353 }, "name": "SrvRecordValue", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The server host name." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 372 }, "name": "hostName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The port." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 367 }, "name": "port", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The priority." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 357 }, "name": "priority", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The weight." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 362 }, "name": "weight", "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-route53.TxtRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet" }, "stability": "stable", "summary": "A DNS TXT record." }, "fqn": "@aws-cdk/aws-route53.TxtRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 321 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.TxtRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 320 }, "name": "TxtRecord" }, "@aws-cdk/aws-route53.TxtRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a TxtRecord." }, "fqn": "@aws-cdk/aws-route53.TxtRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 308 }, "name": "TxtRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The text values." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 312 }, "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ] }, "@aws-cdk/aws-route53.ZoneDelegationOptions": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Options available when creating a delegation relationship from one PublicHostedZone to another." }, "fqn": "@aws-cdk/aws-route53.ZoneDelegationOptions", "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 258 }, "name": "ZoneDelegationOptions", "properties": [ { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "A comment to add on the DNS record created to incorporate the delegation." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 264 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "172800", "stability": "stable", "summary": "The TTL (Time To Live) of the DNS delegation record in DNS caches." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 271 }, "name": "ttl", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } } ] }, "@aws-cdk/aws-route53.ZoneDelegationRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "stability": "stable", "summary": "A record to delegate further lookups to a different set of name servers." }, "fqn": "@aws-cdk/aws-route53.ZoneDelegationRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 549 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.ZoneDelegationRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 548 }, "name": "ZoneDelegationRecord" }, "@aws-cdk/aws-route53.ZoneDelegationRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a ZoneDelegationRecord." }, "fqn": "@aws-cdk/aws-route53.ZoneDelegationRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 538 }, "name": "ZoneDelegationRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The name servers to report in the delegation records." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 542 }, "name": "nameServers", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ] } }, "version": "1.64.0", "fingerprint": "z8+q6iJO5mfDRCHZOs7AOXrQzzIYFd/Liji7AWTiIuo=" }