{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/aws-ec2": "1.204.0", "@aws-cdk/aws-iam": "1.204.0", "@aws-cdk/aws-logs": "1.204.0", "@aws-cdk/cloud-assembly-schema": "1.204.0", "@aws-cdk/core": "1.204.0", "@aws-cdk/custom-resources": "1.204.0", "constructs": "^3.3.69" }, "dependencyClosure": { "@aws-cdk/assets": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.Assets", "packageId": "Amazon.CDK.Assets" }, "java": { "maven": { "artifactId": "cdk-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.assets" }, "js": { "npm": "@aws-cdk/assets" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.assets", "module": "aws_cdk.assets" } } }, "@aws-cdk/aws-applicationautoscaling": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.ApplicationAutoScaling", "packageId": "Amazon.CDK.AWS.ApplicationAutoScaling" }, "java": { "maven": { "artifactId": "applicationautoscaling", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.applicationautoscaling" }, "js": { "npm": "@aws-cdk/aws-applicationautoscaling" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-applicationautoscaling", "module": "aws_cdk.aws_applicationautoscaling" } } }, "@aws-cdk/aws-autoscaling-common": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.AutoScaling.Common", "packageId": "Amazon.CDK.AWS.AutoScaling.Common" }, "java": { "maven": { "artifactId": "autoscaling-common", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.autoscaling.common" }, "js": { "npm": "@aws-cdk/aws-autoscaling-common" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-autoscaling-common", "module": "aws_cdk.aws_autoscaling_common" } } }, "@aws-cdk/aws-cloudformation": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CloudFormation", "packageId": "Amazon.CDK.AWS.CloudFormation" }, "java": { "maven": { "artifactId": "cloudformation", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.cloudformation" }, "js": { "npm": "@aws-cdk/aws-cloudformation" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-cloudformation", "module": "aws_cdk.aws_cloudformation" } } }, "@aws-cdk/aws-cloudwatch": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CloudWatch", "packageId": "Amazon.CDK.AWS.CloudWatch" }, "java": { "maven": { "artifactId": "cloudwatch", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.cloudwatch" }, "js": { "npm": "@aws-cdk/aws-cloudwatch" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-cloudwatch", "module": "aws_cdk.aws_cloudwatch" } } }, "@aws-cdk/aws-codeguruprofiler": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CodeGuruProfiler", "packageId": "Amazon.CDK.AWS.CodeGuruProfiler" }, "java": { "maven": { "artifactId": "codeguruprofiler", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codeguruprofiler" }, "js": { "npm": "@aws-cdk/aws-codeguruprofiler" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-codeguruprofiler", "module": "aws_cdk.aws_codeguruprofiler" } } }, "@aws-cdk/aws-codestarnotifications": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CodeStarNotifications", "packageId": "Amazon.CDK.AWS.CodeStarNotifications" }, "java": { "maven": { "artifactId": "codestarnotifications", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codestarnotifications" }, "js": { "npm": "@aws-cdk/aws-codestarnotifications" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-codestarnotifications", "module": "aws_cdk.aws_codestarnotifications" } } }, "@aws-cdk/aws-ec2": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.EC2", "packageId": "Amazon.CDK.AWS.EC2" }, "java": { "maven": { "artifactId": "ec2", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ec2" }, "js": { "npm": "@aws-cdk/aws-ec2" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ec2", "module": "aws_cdk.aws_ec2" } } }, "@aws-cdk/aws-ecr": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.ECR", "packageId": "Amazon.CDK.AWS.ECR" }, "java": { "maven": { "artifactId": "ecr", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ecr" }, "js": { "npm": "@aws-cdk/aws-ecr" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ecr", "module": "aws_cdk.aws_ecr" } } }, "@aws-cdk/aws-ecr-assets": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Ecr.Assets", "packageId": "Amazon.CDK.ECR.Assets" }, "java": { "maven": { "artifactId": "ecr-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ecr.assets" }, "js": { "npm": "@aws-cdk/aws-ecr-assets" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ecr-assets", "module": "aws_cdk.aws_ecr_assets" } } }, "@aws-cdk/aws-efs": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.EFS", "packageId": "Amazon.CDK.AWS.EFS" }, "java": { "maven": { "artifactId": "efs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.efs" }, "js": { "npm": "@aws-cdk/aws-efs" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-efs", "module": "aws_cdk.aws_efs" } } }, "@aws-cdk/aws-events": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Events", "packageId": "Amazon.CDK.AWS.Events" }, "java": { "maven": { "artifactId": "events", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.events" }, "js": { "npm": "@aws-cdk/aws-events" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-events", "module": "aws_cdk.aws_events" } } }, "@aws-cdk/aws-iam": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.IAM", "packageId": "Amazon.CDK.AWS.IAM" }, "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-iam", "module": "aws_cdk.aws_iam" } } }, "@aws-cdk/aws-kms": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.KMS", "packageId": "Amazon.CDK.AWS.KMS" }, "java": { "maven": { "artifactId": "kms", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.kms" }, "js": { "npm": "@aws-cdk/aws-kms" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-kms", "module": "aws_cdk.aws_kms" } } }, "@aws-cdk/aws-lambda": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Lambda", "packageId": "Amazon.CDK.AWS.Lambda" }, "java": { "maven": { "artifactId": "lambda", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.lambda" }, "js": { "npm": "@aws-cdk/aws-lambda" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-lambda", "module": "aws_cdk.aws_lambda" } } }, "@aws-cdk/aws-logs": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Logs", "packageId": "Amazon.CDK.AWS.Logs" }, "java": { "maven": { "artifactId": "logs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.logs" }, "js": { "npm": "@aws-cdk/aws-logs" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-logs", "module": "aws_cdk.aws_logs" } } }, "@aws-cdk/aws-s3": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3", "packageId": "Amazon.CDK.AWS.S3" }, "java": { "maven": { "artifactId": "s3", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3" }, "js": { "npm": "@aws-cdk/aws-s3" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-s3", "module": "aws_cdk.aws_s3" } } }, "@aws-cdk/aws-s3-assets": { "targets": { "dotnet": { "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" }, "java": { "maven": { "artifactId": "s3-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3.assets" }, "js": { "npm": "@aws-cdk/aws-s3-assets" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-s3-assets", "module": "aws_cdk.aws_s3_assets" } } }, "@aws-cdk/aws-signer": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Signer", "packageId": "Amazon.CDK.AWS.Signer" }, "java": { "maven": { "artifactId": "signer", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.signer" }, "js": { "npm": "@aws-cdk/aws-signer" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-signer", "module": "aws_cdk.aws_signer" } } }, "@aws-cdk/aws-sns": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SNS", "packageId": "Amazon.CDK.AWS.SNS" }, "java": { "maven": { "artifactId": "sns", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.sns" }, "js": { "npm": "@aws-cdk/aws-sns" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-sns", "module": "aws_cdk.aws_sns" } } }, "@aws-cdk/aws-sqs": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SQS", "packageId": "Amazon.CDK.AWS.SQS" }, "java": { "maven": { "artifactId": "sqs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.sqs" }, "js": { "npm": "@aws-cdk/aws-sqs" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-sqs", "module": "aws_cdk.aws_sqs" } } }, "@aws-cdk/aws-ssm": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SSM", "packageId": "Amazon.CDK.AWS.SSM" }, "java": { "maven": { "artifactId": "ssm", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ssm" }, "js": { "npm": "@aws-cdk/aws-ssm" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ssm", "module": "aws_cdk.aws_ssm" } } }, "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "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": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK" }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/custom-resources": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CustomResources", "packageId": "Amazon.CDK.AWS.CustomResources" }, "java": { "maven": { "artifactId": "cdk-customresources", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.customresources" }, "js": { "npm": "@aws-cdk/custom-resources" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.custom-resources", "module": "aws_cdk.custom_resources" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI" }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo" }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "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": { "deprecated": "AWS CDK v1 has reached End-of-Support on 2023-06-01.\nThis package is no longer being updated, and users should migrate to AWS CDK v2.\n\nFor more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html", "stability": "stable" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.84.0 (build 5404dcf)", "keywords": [ "aws", "cdk", "constructs", "route53" ], "license": "Apache-2.0", "metadata": { "jsii": { "compiledWithDeprecationWarnings": true, "pacmak": { "hasDefaultInterfaces": true }, "rosetta": { "strict": true } } }, "name": "@aws-cdk/aws-route53", "readme": { "markdown": "# Amazon Route53 Construct Library\n\n\n---\n\n![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge)\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [_Migrating to AWS CDK v2_ guide][doc].\n>\n> [doc]: https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html\n\n---\n\n\n\nTo add a public hosted zone:\n\n```ts\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\ndeclare const vpc: ec2.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\n```ts\ndeclare const myZone: route53.HostedZone;\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 NS record to your zone:\n\n```ts\ndeclare const myZone: route53.HostedZone;\n\nnew route53.NsRecord(this, 'NSRecord', {\n zone: myZone,\n recordName: 'foo',\n values: [\n 'ns-1.awsdns.co.uk.',\n 'ns-2.awsdns.com.',\n ],\n ttl: Duration.minutes(90), // Optional - default is 30 minutes\n});\n```\n\nTo add a DS record to your zone:\n\n```ts\ndeclare const myZone: route53.HostedZone;\n\nnew route53.DsRecord(this, 'DSRecord', {\n zone: myZone,\n recordName: 'foo',\n values: [\n '12345 3 1 123456789abcdef67890123456789abcdef67890',\n ],\n ttl: Duration.minutes(90), // Optional - default is 30 minutes\n});\n```\n\nTo add an A record to your zone:\n\n```ts\ndeclare const myZone: route53.HostedZone;\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 an A record for an EC2 instance with an Elastic IP (EIP) to your zone:\n\n```ts\ndeclare const instance: ec2.Instance;\n\nconst elasticIp = new ec2.CfnEIP(this, 'EIP', {\n domain: 'vpc',\n instanceId: instance.instanceId,\n});\n\ndeclare const myZone: route53.HostedZone;\nnew route53.ARecord(this, 'ARecord', {\n zone: myZone,\n target: route53.RecordTarget.fromIpAddresses(elasticIp.ref),\n});\n```\n\nTo add an AAAA record pointing to a CloudFront distribution:\n\n```ts\nimport * as cloudfront from '@aws-cdk/aws-cloudfront';\n\ndeclare const myZone: route53.HostedZone;\ndeclare const distribution: cloudfront.CloudFrontWebDistribution;\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\nTo add a NS record to a HostedZone in different account you can do the following:\n\nIn the account containing the parent hosted zone:\n\n```ts\nconst parentZone = new route53.PublicHostedZone(this, 'HostedZone', {\n zoneName: 'someexample.com',\n crossAccountZoneDelegationPrincipal: new iam.AccountPrincipal('12345678901'),\n crossAccountZoneDelegationRoleName: 'MyDelegationRole',\n});\n```\n\nIn the account containing the child zone to be delegated:\n\n```ts\nconst subZone = new route53.PublicHostedZone(this, 'SubZone', {\n zoneName: 'sub.someexample.com',\n});\n\n// import the delegation role by constructing the roleArn\nconst delegationRoleArn = Stack.of(this).formatArn({\n region: '', // IAM is global in each partition\n service: 'iam',\n account: 'parent-account-id',\n resource: 'role',\n resourceName: 'MyDelegationRole',\n});\nconst delegationRole = iam.Role.fromRoleArn(this, 'DelegationRole', delegationRoleArn);\n\n// create the record\nnew route53.CrossAccountZoneDelegationRecord(this, 'delegate', {\n delegatedZone: subZone,\n parentHostedZoneName: 'someexample.com', // or you can use parentHostedZoneId\n delegationRole,\n});\n```\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\nroute53.HostedZone.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```text\nnew MyDevStack(app, 'dev', {\n env: {\n account: process.env.CDK_DEFAULT_ACCOUNT,\n region: process.env.CDK_DEFAULT_REGION,\n },\n});\n```\n\nIf you know the ID and Name of a Hosted Zone, you can import it directly:\n\n```ts\nconst zone = route53.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 = route53.HostedZone.fromHostedZoneId(this, 'MyZone', 'ZOJJZC49E0EPZ');\n```\n\nYou can import a Public Hosted Zone as well with the similar `PubicHostedZone.fromPublicHostedZoneId` and `PubicHostedZone.fromPublicHostedZoneAttributes` methods:\n\n```ts\nconst zoneFromAttributes = route53.PublicHostedZone.fromPublicHostedZoneAttributes(this, 'MyZone', {\n zoneName: 'example.com',\n hostedZoneId: 'ZOJJZC49E0EPZ',\n});\n\n// Does not know zoneName\nconst zoneFromId = route53.PublicHostedZone.fromPublicHostedZoneId(this, 'MyZone', 'ZOJJZC49E0EPZ');\n```\n\n## VPC Endpoint Service Private DNS\n\nWhen you create a VPC endpoint service, AWS generates endpoint-specific DNS hostnames that consumers use to communicate with the service.\nFor example, vpce-1234-abcdev-us-east-1.vpce-svc-123345.us-east-1.vpce.amazonaws.com.\nBy default, your consumers access the service with that DNS name.\nThis can cause problems with HTTPS traffic because the DNS will not match the backend certificate:\n\n```console\ncurl: (60) SSL: no alternative certificate subject name matches target host name 'vpce-abcdefghijklmnopq-rstuvwx.vpce-svc-abcdefghijklmnopq.us-east-1.vpce.amazonaws.com'\n```\n\nEffectively, the endpoint appears untrustworthy. To mitigate this, clients have to create an alias for this DNS name in Route53.\n\nPrivate DNS for an endpoint service lets you configure a private DNS name so consumers can\naccess the service using an existing DNS name without creating this Route53 DNS alias\nThis DNS name can also be guaranteed to match up with the backend certificate.\n\nBefore consumers can use the private DNS name, you must verify that you have control of the domain/subdomain.\n\nAssuming your account has ownership of the particular domain/subdomain,\nthis construct sets up the private DNS configuration on the endpoint service,\ncreates all the necessary Route53 entries, and verifies domain ownership.\n\n```ts nofixture\nimport { Stack } from '@aws-cdk/core';\nimport { Vpc, VpcEndpointService } from '@aws-cdk/aws-ec2';\nimport { NetworkLoadBalancer } from '@aws-cdk/aws-elasticloadbalancingv2';\nimport { PublicHostedZone, VpcEndpointServiceDomainName } from '@aws-cdk/aws-route53';\n\nconst stack = new Stack();\nconst vpc = new Vpc(stack, 'VPC');\nconst nlb = new NetworkLoadBalancer(stack, 'NLB', {\n vpc,\n});\nconst vpces = new VpcEndpointService(stack, 'VPCES', {\n vpcEndpointServiceLoadBalancers: [nlb],\n});\n// You must use a public hosted zone so domain ownership can be verified\nconst zone = new PublicHostedZone(stack, 'PHZ', {\n zoneName: 'aws-cdk.dev',\n});\nnew VpcEndpointServiceDomainName(stack, 'EndpointDomain', {\n endpointService: vpces,\n domainName: 'my-stuff.aws-cdk.dev',\n publicHostedZone: zone,\n});\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": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Route53", "packageId": "Amazon.CDK.AWS.Route53" }, "java": { "maven": { "artifactId": "route53", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.route53" }, "js": { "npm": "@aws-cdk/aws-route53" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "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", "exampleMetadata": "infused" }, "stability": "stable", "summary": "A DNS A record.", "example": "import * as apigw from '@aws-cdk/aws-apigateway';\n\ndeclare const zone: route53.HostedZone;\ndeclare const restApi: apigw.LambdaRestApi;\n\nnew route53.ARecord(this, 'AliasRecord', {\n zone,\n target: route53.RecordTarget.fromAlias(new targets.ApiGateway(restApi)),\n // or - route53.RecordTarget.fromAlias(new alias.ApiGatewayDomain(domainName)),\n});" }, "fqn": "@aws-cdk/aws-route53.ARecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 262 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.ARecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 261 }, "name": "ARecord", "symbolId": "lib/record-set:ARecord" }, "@aws-cdk/aws-route53.ARecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a ARecord.", "example": "import * as apigw from '@aws-cdk/aws-apigateway';\n\ndeclare const zone: route53.HostedZone;\ndeclare const restApi: apigw.LambdaRestApi;\n\nnew route53.ARecord(this, 'AliasRecord', {\n zone,\n target: route53.RecordTarget.fromAlias(new targets.ApiGateway(restApi)),\n // or - route53.RecordTarget.fromAlias(new alias.ApiGatewayDomain(domainName)),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.ARecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 249 }, "name": "ARecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The target." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 253 }, "name": "target", "type": { "fqn": "@aws-cdk/aws-route53.RecordTarget" } } ], "symbolId": "lib/record-set:ARecordProps" }, "@aws-cdk/aws-route53.AaaaRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet", "exampleMetadata": "infused" }, "stability": "stable", "summary": "A DNS AAAA record.", "example": "import * as cloudfront from '@aws-cdk/aws-cloudfront';\n\ndeclare const myZone: route53.HostedZone;\ndeclare const distribution: cloudfront.CloudFrontWebDistribution;\nnew route53.AaaaRecord(this, 'Alias', {\n zone: myZone,\n target: route53.RecordTarget.fromAlias(new targets.CloudFrontTarget(distribution)),\n});" }, "fqn": "@aws-cdk/aws-route53.AaaaRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 287 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.AaaaRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 286 }, "name": "AaaaRecord", "symbolId": "lib/record-set:AaaaRecord" }, "@aws-cdk/aws-route53.AaaaRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a AaaaRecord.", "example": "import * as cloudfront from '@aws-cdk/aws-cloudfront';\n\ndeclare const myZone: route53.HostedZone;\ndeclare const distribution: cloudfront.CloudFrontWebDistribution;\nnew route53.AaaaRecord(this, 'Alias', {\n zone: myZone,\n target: route53.RecordTarget.fromAlias(new targets.CloudFrontTarget(distribution)),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.AaaaRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 274 }, "name": "AaaaRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The target." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 278 }, "name": "target", "type": { "fqn": "@aws-cdk/aws-route53.RecordTarget" } } ], "symbolId": "lib/record-set:AaaaRecordProps" }, "@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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\n\ndeclare const aliasRecordTarget: route53.IAliasRecordTarget;\nconst addressRecordTarget = route53.AddressRecordTarget.fromAlias(aliasRecordTarget);", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.AddressRecordTarget", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 193 }, "parameters": [ { "docs": { "summary": "correspond with the chosen record type (e.g. for 'A' Type, specify one or 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": 243 }, "name": "AddressRecordTarget", "symbolId": "lib/record-set: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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst aliasRecordTargetConfig: route53.AliasRecordTargetConfig = {\n dnsName: 'dnsName',\n hostedZoneId: 'hostedZoneId',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.AliasRecordTargetConfig", "kind": "interface", "locationInModule": { "filename": "lib/alias-record-target.ts", "line": 18 }, "name": "AliasRecordTargetConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "DNS name of the target." }, "immutable": true, "locationInModule": { "filename": "lib/alias-record-target.ts", "line": 27 }, "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": 22 }, "name": "hostedZoneId", "type": { "primitive": "string" } } ], "symbolId": "lib/alias-record-target:AliasRecordTargetConfig" }, "@aws-cdk/aws-route53.CaaAmazonRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.CaaRecord", "docs": { "custom": { "resource": "AWS::Route53::RecordSet", "exampleMetadata": "fixture=_generated" }, "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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const hostedZone: route53.HostedZone;\nconst caaAmazonRecord = new route53.CaaAmazonRecord(this, 'MyCaaAmazonRecord', {\n zone: hostedZone,\n\n // the properties below are optional\n comment: 'comment',\n recordName: 'recordName',\n ttl: cdk.Duration.minutes(30),\n});" }, "fqn": "@aws-cdk/aws-route53.CaaAmazonRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 497 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.CaaAmazonRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 496 }, "name": "CaaAmazonRecord", "symbolId": "lib/record-set:CaaAmazonRecord" }, "@aws-cdk/aws-route53.CaaAmazonRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a CaaAmazonRecord.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const hostedZone: route53.HostedZone;\nconst caaAmazonRecordProps: route53.CaaAmazonRecordProps = {\n zone: hostedZone,\n\n // the properties below are optional\n comment: 'comment',\n recordName: 'recordName',\n ttl: cdk.Duration.minutes(30),\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.CaaAmazonRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 486 }, "name": "CaaAmazonRecordProps", "symbolId": "lib/record-set:CaaAmazonRecordProps" }, "@aws-cdk/aws-route53.CaaRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet", "exampleMetadata": "fixture=_generated" }, "stability": "stable", "summary": "A DNS CAA record.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const hostedZone: route53.HostedZone;\nconst caaRecord = new route53.CaaRecord(this, 'MyCaaRecord', {\n values: [{\n flag: 123,\n tag: route53.CaaTag.ISSUE,\n value: 'value',\n }],\n zone: hostedZone,\n\n // the properties below are optional\n comment: 'comment',\n recordName: 'recordName',\n ttl: cdk.Duration.minutes(30),\n});" }, "fqn": "@aws-cdk/aws-route53.CaaRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 474 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.CaaRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 473 }, "name": "CaaRecord", "symbolId": "lib/record-set:CaaRecord" }, "@aws-cdk/aws-route53.CaaRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a CaaRecord.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const hostedZone: route53.HostedZone;\nconst caaRecordProps: route53.CaaRecordProps = {\n values: [{\n flag: 123,\n tag: route53.CaaTag.ISSUE,\n value: 'value',\n }],\n zone: hostedZone,\n\n // the properties below are optional\n comment: 'comment',\n recordName: 'recordName',\n ttl: cdk.Duration.minutes(30),\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.CaaRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 461 }, "name": "CaaRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The values." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 465 }, "name": "values", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-route53.CaaRecordValue" }, "kind": "array" } } } ], "symbolId": "lib/record-set:CaaRecordProps" }, "@aws-cdk/aws-route53.CaaRecordValue": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a CAA record value.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst caaRecordValue: route53.CaaRecordValue = {\n flag: 123,\n tag: route53.CaaTag.ISSUE,\n value: 'value',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.CaaRecordValue", "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 441 }, "name": "CaaRecordValue", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The flag." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 445 }, "name": "flag", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The tag." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 450 }, "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": 455 }, "name": "value", "type": { "primitive": "string" } } ], "symbolId": "lib/record-set:CaaRecordValue" }, "@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": 418 }, "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", "symbolId": "lib/record-set:CaaTag" }, "@aws-cdk/aws-route53.CfnCidrCollection": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Route53::CidrCollection", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Creates a CIDR collection in the current AWS account.", "stability": "external", "summary": "A CloudFormation `AWS::Route53::CidrCollection`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cfnCidrCollection = new route53.CfnCidrCollection(this, 'MyCfnCidrCollection', {\n name: 'name',\n\n // the properties below are optional\n locations: [{\n cidrList: ['cidrList'],\n locationName: 'locationName',\n }],\n});" }, "fqn": "@aws-cdk/aws-route53.CfnCidrCollection", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Route53::CidrCollection`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 153 }, "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.CfnCidrCollectionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 95 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 169 }, "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": 181 }, "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": "CfnCidrCollection", "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": 99 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "\"The Amazon resource name (ARN) to uniquely identify the AWS resource." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 124 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "stability": "external", "summary": "The UUID of the CIDR collection." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 130 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 174 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html#cfn-route53-cidrcollection-name" }, "stability": "external", "summary": "The name of a CIDR collection." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 137 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html#cfn-route53-cidrcollection-locations" }, "stability": "external", "summary": "A complex type that contains information about the list of CIDR locations." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 144 }, "name": "locations", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/aws-route53.CfnCidrCollection.LocationProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/route53.generated:CfnCidrCollection" }, "@aws-cdk/aws-route53.CfnCidrCollection.LocationProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrcollection-location.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Specifies the list of CIDR blocks for a CIDR location.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst locationProperty: route53.CfnCidrCollection.LocationProperty = {\n cidrList: ['cidrList'],\n locationName: 'locationName',\n};" }, "fqn": "@aws-cdk/aws-route53.CfnCidrCollection.LocationProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 195 }, "name": "LocationProperty", "namespace": "CfnCidrCollection", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrcollection-location.html#cfn-route53-cidrcollection-location-cidrlist" }, "stability": "external", "summary": "List of CIDR blocks." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 201 }, "name": "cidrList", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrcollection-location.html#cfn-route53-cidrcollection-location-locationname" }, "stability": "external", "summary": "The CIDR collection location name." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 207 }, "name": "locationName", "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnCidrCollection.LocationProperty" }, "@aws-cdk/aws-route53.CfnCidrCollectionProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnCidrCollection`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cfnCidrCollectionProps: route53.CfnCidrCollectionProps = {\n name: 'name',\n\n // the properties below are optional\n locations: [{\n cidrList: ['cidrList'],\n locationName: 'locationName',\n }],\n};" }, "fqn": "@aws-cdk/aws-route53.CfnCidrCollectionProps", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 19 }, "name": "CfnCidrCollectionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html#cfn-route53-cidrcollection-name" }, "stability": "external", "summary": "The name of a CIDR collection." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 26 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html#cfn-route53-cidrcollection-locations" }, "stability": "external", "summary": "A complex type that contains information about the list of CIDR locations." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 33 }, "name": "locations", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/aws-route53.CfnCidrCollection.LocationProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/route53.generated:CfnCidrCollectionProps" }, "@aws-cdk/aws-route53.CfnDNSSEC": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Route53::DNSSEC", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-dnssec.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Route53::DNSSEC` resource is used to enable DNSSEC signing in a hosted zone.", "stability": "external", "summary": "A CloudFormation `AWS::Route53::DNSSEC`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cfnDNSSEC = new route53.CfnDNSSEC(this, 'MyCfnDNSSEC', {\n hostedZoneId: 'hostedZoneId',\n});" }, "fqn": "@aws-cdk/aws-route53.CfnDNSSEC", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Route53::DNSSEC`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 377 }, "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.CfnDNSSECProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 338 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 390 }, "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": 401 }, "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": "CfnDNSSEC", "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": 342 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 395 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-dnssec.html#cfn-route53-dnssec-hostedzoneid" }, "remarks": "For example: `Z00001111A1ABCaaABC11` .", "stability": "external", "summary": "A unique string (ID) that is used to identify a hosted zone." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 368 }, "name": "hostedZoneId", "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnDNSSEC" }, "@aws-cdk/aws-route53.CfnDNSSECProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-dnssec.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDNSSEC`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cfnDNSSECProps: route53.CfnDNSSECProps = {\n hostedZoneId: 'hostedZoneId',\n};" }, "fqn": "@aws-cdk/aws-route53.CfnDNSSECProps", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 272 }, "name": "CfnDNSSECProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-dnssec.html#cfn-route53-dnssec-hostedzoneid" }, "remarks": "For example: `Z00001111A1ABCaaABC11` .", "stability": "external", "summary": "A unique string (ID) that is used to identify a hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 279 }, "name": "hostedZoneId", "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnDNSSECProps" }, "@aws-cdk/aws-route53.CfnHealthCheck": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Route53::HealthCheck", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Route53::HealthCheck` resource is a Route 53 resource type that contains settings for a Route 53 health check.\n\nFor information about associating health checks with records, see [HealthCheckId](https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResourceRecordSet.html#Route53-Type-ResourceRecordSet-HealthCheckId) in [ChangeResourceRecordSets](https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html) .\n\n> You can't create a health check with simple routing.\n\n*ELB Load Balancers*\n\nIf you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check.\n\n*Private Hosted Zones*\n\nYou can associate health checks with failover records in a private hosted zone. Note the following:\n\n- Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.\n- You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.\n- You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 `StatusCheckFailed` metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatch.html) .", "stability": "external", "summary": "A CloudFormation `AWS::Route53::HealthCheck`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cfnHealthCheck = new route53.CfnHealthCheck(this, 'MyCfnHealthCheck', {\n healthCheckConfig: {\n type: 'type',\n\n // the properties below are optional\n alarmIdentifier: {\n name: 'name',\n region: 'region',\n },\n childHealthChecks: ['childHealthChecks'],\n enableSni: false,\n failureThreshold: 123,\n fullyQualifiedDomainName: 'fullyQualifiedDomainName',\n healthThreshold: 123,\n insufficientDataHealthStatus: 'insufficientDataHealthStatus',\n inverted: false,\n ipAddress: 'ipAddress',\n measureLatency: false,\n port: 123,\n regions: ['regions'],\n requestInterval: 123,\n resourcePath: 'resourcePath',\n routingControlArn: 'routingControlArn',\n searchString: 'searchString',\n },\n\n // the properties below are optional\n healthCheckTags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-route53.CfnHealthCheck", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Route53::HealthCheck`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 562 }, "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": 508 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 577 }, "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": 589 }, "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": 512 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "HealthCheckId" }, "remarks": "When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.", "stability": "external", "summary": "The identifier that Amazon Route 53 assigned to the health check when you created it." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 537 }, "name": "attrHealthCheckId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 582 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig" }, "remarks": "For the values to enter for `HealthCheckConfig` , see [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html)", "stability": "external", "summary": "A complex type that contains detailed information about one health check." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 546 }, "name": "healthCheckConfig", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHealthCheck.HealthCheckConfigProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags" }, "stability": "external", "summary": "The `HealthCheckTags` property describes key-value pairs that are associated with an `AWS::Route53::HealthCheck` resource." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 553 }, "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" } } ] } } } ], "symbolId": "lib/route53.generated:CfnHealthCheck" }, "@aws-cdk/aws-route53.CfnHealthCheck.AlarmIdentifierProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst alarmIdentifierProperty: route53.CfnHealthCheck.AlarmIdentifierProperty = {\n name: 'name',\n region: 'region',\n};" }, "fqn": "@aws-cdk/aws-route53.CfnHealthCheck.AlarmIdentifierProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 603 }, "name": "AlarmIdentifierProperty", "namespace": "CfnHealthCheck", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-name" }, "remarks": "> Route 53 supports CloudWatch alarms with the following features:\n>\n> - Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see [High-Resolution Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics) in the *Amazon CloudWatch User Guide* .\n> - Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.", "stability": "external", "summary": "The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 614 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-region" }, "remarks": "For the current list of CloudWatch regions, see [Amazon CloudWatch endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/cw_region.html) in the *Amazon Web Services General Reference* .", "stability": "external", "summary": "For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 622 }, "name": "region", "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnHealthCheck.AlarmIdentifierProperty" }, "@aws-cdk/aws-route53.CfnHealthCheck.HealthCheckConfigProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A complex type that contains information about the health check.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst healthCheckConfigProperty: route53.CfnHealthCheck.HealthCheckConfigProperty = {\n type: 'type',\n\n // the properties below are optional\n alarmIdentifier: {\n name: 'name',\n region: 'region',\n },\n childHealthChecks: ['childHealthChecks'],\n enableSni: false,\n failureThreshold: 123,\n fullyQualifiedDomainName: 'fullyQualifiedDomainName',\n healthThreshold: 123,\n insufficientDataHealthStatus: 'insufficientDataHealthStatus',\n inverted: false,\n ipAddress: 'ipAddress',\n measureLatency: false,\n port: 123,\n regions: ['regions'],\n requestInterval: 123,\n resourcePath: 'resourcePath',\n routingControlArn: 'routingControlArn',\n searchString: 'searchString',\n};" }, "fqn": "@aws-cdk/aws-route53.CfnHealthCheck.HealthCheckConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 688 }, "name": "HealthCheckConfigProperty", "namespace": "CfnHealthCheck", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type" }, "remarks": "> You can't change the value of `Type` after you create a health check.\n\nYou can create the following types of health checks:\n\n- *HTTP* : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.\n- *HTTPS* : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.\n\n> If you specify `HTTPS` for the value of `Type` , the endpoint must support TLS v1.0 or later.\n- *HTTP_STR_MATCH* : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in `SearchString` .\n- *HTTPS_STR_MATCH* : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an `HTTPS` request and searches the first 5,120 bytes of the response body for the string that you specify in `SearchString` .\n- *TCP* : Route 53 tries to establish a TCP connection.\n- *CLOUDWATCH_METRIC* : The health check is associated with a CloudWatch alarm. If the state of the alarm is `OK` , the health check is considered healthy. If the state is `ALARM` , the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is `OK` or `ALARM` , the health check status depends on the setting for `InsufficientDataHealthStatus` : `Healthy` , `Unhealthy` , or `LastKnownStatus` .\n- *CALCULATED* : For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of `HealthThreshold` .\n- *RECOVERY_CONTROL* : The health check is assocated with a Route53 Application Recovery Controller routing control. If the routing control state is `ON` , the health check is considered healthy. If the state is `OFF` , the health check is considered unhealthy.\n\nFor more information, see [How Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) in the *Amazon Route 53 Developer Guide* .", "stability": "external", "summary": "The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 877 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-alarmidentifier" }, "stability": "external", "summary": "A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 694 }, "name": "alarmIdentifier", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHealthCheck.AlarmIdentifierProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-childhealthchecks" }, "stability": "external", "summary": "(CALCULATED Health Checks Only) A complex type that contains one `ChildHealthCheck` element for each health check that you want to associate with a `CALCULATED` health check." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 700 }, "name": "childHealthChecks", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-enablesni" }, "remarks": "This allows the endpoint to respond to `HTTPS` health check requests with the applicable SSL/TLS certificate.\n\nSome endpoints require that `HTTPS` requests include the host name in the `client_hello` message. If you don't enable SNI, the status of the health check will be `SSL alert handshake_failure` . A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.\n\nThe SSL/TLS certificate on your endpoint includes a domain name in the `Common Name` field and possibly several more in the `Subject Alternative Names` field. One of the domain names in the certificate should match the value that you specify for `FullyQualifiedDomainName` . If the endpoint responds to the `client_hello` message with a certificate that does not include the domain name that you specified in `FullyQualifiedDomainName` , a health checker will retry the handshake. In the second attempt, the health checker will omit `FullyQualifiedDomainName` from the `client_hello` message.", "stability": "external", "summary": "Specify whether you want Amazon Route 53 to send the value of `FullyQualifiedDomainName` to the endpoint in the `client_hello` message during TLS negotiation." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 710 }, "name": "enableSni", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-failurethreshold" }, "remarks": "For more information, see [How Amazon Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) in the *Amazon Route 53 Developer Guide* .\n\nIf you don't specify a value for `FailureThreshold` , the default value is three health checks.", "stability": "external", "summary": "The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 718 }, "name": "failureThreshold", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-fullyqualifieddomainname" }, "remarks": "*If you specify a value for* `IPAddress` :\n\nAmazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of `FullyQualifiedDomainName` in the `Host` header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.\n\nWhen Route 53 checks the health of an endpoint, here is how it constructs the `Host` header:\n\n- If you specify a value of `80` for `Port` and `HTTP` or `HTTP_STR_MATCH` for `Type` , Route 53 passes the value of `FullyQualifiedDomainName` to the endpoint in the Host header.\n- If you specify a value of `443` for `Port` and `HTTPS` or `HTTPS_STR_MATCH` for `Type` , Route 53 passes the value of `FullyQualifiedDomainName` to the endpoint in the `Host` header.\n- If you specify another value for `Port` and any value except `TCP` for `Type` , Route 53 passes `FullyQualifiedDomainName:Port` to the endpoint in the `Host` header.\n\nIf you don't specify a value for `FullyQualifiedDomainName` , Route 53 substitutes the value of `IPAddress` in the `Host` header in each of the preceding cases.\n\n*If you don't specify a value for `IPAddress`* :\n\nRoute 53 sends a DNS request to the domain that you specify for `FullyQualifiedDomainName` at the interval that you specify for `RequestInterval` . Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.\n\n> If you don't specify a value for `IPAddress` , Route 53 uses only IPv4 to send health checks to the endpoint. If there's no record with a type of A for the name that you specify for `FullyQualifiedDomainName` , the health check fails with a \"DNS resolution failed\" error.\n\nIf you want to check the health of multiple records that have the same name and type, such as multiple weighted records, and if you choose to specify the endpoint only by `FullyQualifiedDomainName` , we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of `FullyQualifiedDomainName` , specify the domain name of the server (such as us-east-2-www.example.com), not the name of the records (www.example.com).\n\n> In this configuration, if you create a health check for which the value of `FullyQualifiedDomainName` matches the name of the records and you then associate the health check with those records, health check results will be unpredictable.\n\nIn addition, if the value that you specify for `Type` is `HTTP` , `HTTPS` , `HTTP_STR_MATCH` , or `HTTPS_STR_MATCH` , Route 53 passes the value of `FullyQualifiedDomainName` in the `Host` header, as it does when you specify a value for `IPAddress` . If the value of `Type` is `TCP` , Route 53 doesn't pass a `Host` header.", "stability": "external", "summary": "Amazon Route 53 behavior depends on whether you specify a value for `IPAddress` ." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 748 }, "name": "fullyQualifiedDomainName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-healththreshold" }, "remarks": "To specify the child health checks that you want to associate with a `CALCULATED` health check, use the [ChildHealthChecks](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks) element.\n\nNote the following:\n\n- If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.\n- If you specify `0` , Route 53 always considers this health check to be healthy.", "stability": "external", "summary": "The number of child health checks that are associated with a `CALCULATED` health check that Amazon Route 53 must consider healthy for the `CALCULATED` health check to be considered healthy." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 759 }, "name": "healthThreshold", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-insufficientdatahealthstatus" }, "remarks": "- `Unhealthy` : Route 53 considers the health check to be unhealthy.\n- `LastKnownStatus` : Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.", "stability": "external", "summary": "When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check: - `Healthy` : Route 53 considers the health check to be healthy." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 792 }, "name": "insufficientDataHealthStatus", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-inverted" }, "stability": "external", "summary": "Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 798 }, "name": "inverted", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-ipaddress" }, "remarks": "If you don't specify a value for `IPAddress` , Route 53 sends a DNS request to resolve the domain name that you specify in `FullyQualifiedDomainName` at the interval that you specify in `RequestInterval` . Using an IP address returned by DNS, Route 53 then checks the health of the endpoint.\n\nUse one of the following formats for the value of `IPAddress` :\n\n- *IPv4 address* : four values between 0 and 255, separated by periods (.), for example, `192.0.2.44` .\n- *IPv6 address* : eight groups of four hexadecimal values, separated by colons (:), for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345` . You can also shorten IPv6 addresses as described in RFC 5952, for example, `2001:db8:85a3::abcd:1:2345` .\n\nIf the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for `IPAddress` . This ensures that the IP address of your instance will never change.\n\nFor more information, see [FullyQualifiedDomainName](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName) .\n\nConstraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:\n\n- [RFC 5735, Special Use IPv4 Addresses](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc5735)\n- [RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6598)\n- [RFC 5156, Special-Use IPv6 Addresses](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc5156)\n\nWhen the value of `Type` is `CALCULATED` or `CLOUDWATCH_METRIC` , omit `IPAddress` .", "stability": "external", "summary": "The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 782 }, "name": "ipAddress", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-measurelatency" }, "remarks": "> You can't change the value of `MeasureLatency` after you create a health check.", "stability": "external", "summary": "Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the *Health Checks* page in the Route 53 console." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 806 }, "name": "measureLatency", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-port" }, "remarks": "> Don't specify a value for `Port` when you specify a value for [Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type) of `CLOUDWATCH_METRIC` or `CALCULATED` .", "stability": "external", "summary": "The port on the endpoint that you want Amazon Route 53 to perform health checks on." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 814 }, "name": "port", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-regions" }, "remarks": "If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under *Valid Values* .\n\nIf you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).", "stability": "external", "summary": "A complex type that contains one `Region` element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 824 }, "name": "regions", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-requestinterval" }, "remarks": "Each Route 53 health checker makes requests at this interval.\n\n> You can't change the value of `RequestInterval` after you create a health check.\n\nIf you don't specify a value for `RequestInterval` , the default value is `30` seconds.", "stability": "external", "summary": "The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 834 }, "name": "requestInterval", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-resourcepath" }, "remarks": "The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html. You can also include query string parameters, for example, `/welcome.html?language=jp&login=y` .", "stability": "external", "summary": "The path, if any, that you want Amazon Route 53 to request when performing health checks." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 840 }, "name": "resourcePath", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-routingcontrolarn" }, "stability": "external", "summary": "`CfnHealthCheck.HealthCheckConfigProperty.RoutingControlArn`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 846 }, "name": "routingControlArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-searchstring" }, "remarks": "If the string appears in the response body, Route 53 considers the resource healthy.\n\nRoute 53 considers case when searching for `SearchString` in the response body.", "stability": "external", "summary": "If the value of Type is `HTTP_STR_MATCH` or `HTTPS_STR_MATCH` , the string that you want Amazon Route 53 to search for in the response body from the specified resource." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 854 }, "name": "searchString", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnHealthCheck.HealthCheckConfigProperty" }, "@aws-cdk/aws-route53.CfnHealthCheck.HealthCheckTagProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The `HealthCheckTag` property describes one key-value pair that is associated with an `AWS::Route53::HealthCheck` resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst healthCheckTagProperty: route53.CfnHealthCheck.HealthCheckTagProperty = {\n key: 'key',\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-route53.CfnHealthCheck.HealthCheckTagProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 987 }, "name": "HealthCheckTagProperty", "namespace": "CfnHealthCheck", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthcheck-healthchecktag-key" }, "remarks": "- *Add a tag to a health check or hosted zone* : `Key` is the name that you want to give the new tag.\n- *Edit a tag* : `Key` is the name of the tag that you want to change the `Value` for.\n- *Delete a key* : `Key` is the name of the tag you want to remove.\n- *Give a name to a health check* : Edit the default `Name` tag. In the Amazon Route 53 console, the list of your health checks includes a *Name* column that lets you see the name that you've given to each health check.", "stability": "external", "summary": "The value of `Key` depends on the operation that you want to perform:." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 998 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthcheck-healthchecktag-value" }, "remarks": "- *Add a tag to a health check or hosted zone* : `Value` is the value that you want to give the new tag.\n- *Edit a tag* : `Value` is the new value that you want to assign the tag.", "stability": "external", "summary": "The value of `Value` depends on the operation that you want to perform:." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1007 }, "name": "value", "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnHealthCheck.HealthCheckTagProperty" }, "@aws-cdk/aws-route53.CfnHealthCheckProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnHealthCheck`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cfnHealthCheckProps: route53.CfnHealthCheckProps = {\n healthCheckConfig: {\n type: 'type',\n\n // the properties below are optional\n alarmIdentifier: {\n name: 'name',\n region: 'region',\n },\n childHealthChecks: ['childHealthChecks'],\n enableSni: false,\n failureThreshold: 123,\n fullyQualifiedDomainName: 'fullyQualifiedDomainName',\n healthThreshold: 123,\n insufficientDataHealthStatus: 'insufficientDataHealthStatus',\n inverted: false,\n ipAddress: 'ipAddress',\n measureLatency: false,\n port: 123,\n regions: ['regions'],\n requestInterval: 123,\n resourcePath: 'resourcePath',\n routingControlArn: 'routingControlArn',\n searchString: 'searchString',\n },\n\n // the properties below are optional\n healthCheckTags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-route53.CfnHealthCheckProps", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 414 }, "name": "CfnHealthCheckProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig" }, "remarks": "For the values to enter for `HealthCheckConfig` , see [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html)", "stability": "external", "summary": "A complex type that contains detailed information about one health check." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 423 }, "name": "healthCheckConfig", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHealthCheck.HealthCheckConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags" }, "stability": "external", "summary": "The `HealthCheckTags` property describes key-value pairs that are associated with an `AWS::Route53::HealthCheck` resource." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 430 }, "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" } } ] } } } ], "symbolId": "lib/route53.generated:CfnHealthCheckProps" }, "@aws-cdk/aws-route53.CfnHostedZone": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Route53::HostedZone", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).\n\n> You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.\n\nFor more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/) .\n\nNote the following:\n\n- You can't create a hosted zone for a top-level domain (TLD) such as .com.\n- If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide* .\n\nWhen you submit a `CreateHostedZone` request, the initial status of the hosted zone is `PENDING` . For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to `INSYNC` .\n\nThe `CreateHostedZone` request requires the caller to have an `ec2:DescribeVpcs` permission.\n\n> When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS Regions . Each AWS account is scoped to one partition.\n>\n> The following are the supported partitions:\n>\n> - `aws` - AWS Regions\n> - `aws-cn` - China Regions\n> - `aws-us-gov` - AWS GovCloud (US) Region\n>\n> For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference* .", "stability": "external", "summary": "A CloudFormation `AWS::Route53::HostedZone`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cfnHostedZone = new route53.CfnHostedZone(this, 'MyCfnHostedZone', /* all optional props */ {\n hostedZoneConfig: {\n comment: 'comment',\n },\n hostedZoneTags: [{\n key: 'key',\n value: 'value',\n }],\n name: 'name',\n queryLoggingConfig: {\n cloudWatchLogsLogGroupArn: 'cloudWatchLogsLogGroupArn',\n },\n vpcs: [{\n vpcId: 'vpcId',\n vpcRegion: 'vpcRegion',\n }],\n});" }, "fqn": "@aws-cdk/aws-route53.CfnHostedZone", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Route53::HostedZone`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1391 }, "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.CfnHostedZoneProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1255 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1409 }, "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": 1424 }, "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": 1259 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "stability": "external", "summary": "The ID that Amazon Route 53 assigned to the hosted zone when you created it." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1284 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "NameServers" }, "remarks": "This attribute is not supported for private hosted zones.", "stability": "external", "summary": "Returns the set of name servers for the specific hosted zone. For example: `ns1.example.com` ." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1292 }, "name": "attrNameServers", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1414 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzonetags" }, "remarks": "For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *AWS Billing and Cost Management User Guide* .", "stability": "external", "summary": "Adds, edits, or deletes tags for a health check or a hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1310 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzoneconfig" }, "remarks": "If you don't want to specify a comment, omit the `HostedZoneConfig` and `Comment` elements.", "stability": "external", "summary": "A complex type that contains an optional comment." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1301 }, "name": "hostedZoneConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.HostedZoneConfigProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-name" }, "remarks": "Specify a fully qualified domain name, for example, *www.example.com* . The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical.\n\nIf you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of `NameServers` that are returned by the `Fn::GetAtt` intrinsic function.", "stability": "external", "summary": "The name of the domain." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1319 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-queryloggingconfig" }, "remarks": "After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.\n\nDNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:\n\n- Route 53 edge location that responded to the DNS query\n- Domain or subdomain that was requested\n- DNS record type, such as A or AAAA\n- DNS response code, such as `NoError` or `ServFail`\n\n- **Log Group and Resource Policy** - Before you create a query logging configuration, perform the following operations.\n\n> If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.\n\n- Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:\n\n- You must create the log group in the us-east-1 region.\n- You must use the same AWS account to create the log group and the hosted zone that you want to configure query logging for.\n- When you create log groups for query logging, we recommend that you use a consistent prefix, for example:\n\n`/aws/route53/ *hosted zone name*`\n\nIn the next step, you'll create a resource policy, which controls access to one or more log groups and the associated AWS resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.\n- Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of `Resource` , specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with `*` , for example:\n\n`arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*`\n\nTo avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values:\n\n- For `aws:SourceArn` , supply the hosted zone ARN used in creating the query logging configuration. For example, `aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID` .\n- For `aws:SourceAccount` , supply the account ID for the account that creates the query logging configuration. For example, `aws:SourceAccount:111111111111` .\n\nFor more information, see [The confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html) in the *AWS IAM User Guide* .\n\n> You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI .\n- **Log Streams and Edge Locations** - When Route 53 finishes creating the configuration for DNS query logging, it does the following:\n\n- Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.\n- Begins to send query logs to the applicable log stream.\n\nThe name of each log stream is in the following format:\n\n`*hosted zone ID* / *edge location code*`\n\nThe edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the [Route 53 Product Details](https://docs.aws.amazon.com/route53/details/) page.\n- **Queries That Are Logged** - Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see [Routing Internet Traffic to Your Website or Web Application](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html) in the *Amazon Route 53 Developer Guide* .\n- **Log File Format** - For a list of the values in each query log and the format of each value, see [Logging DNS Queries](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html) in the *Amazon Route 53 Developer Guide* .\n- **Pricing** - For information about charges for query logs, see [Amazon CloudWatch Pricing](https://docs.aws.amazon.com/cloudwatch/pricing/) .\n- **How to Stop Logging** - If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see [DeleteQueryLoggingConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteQueryLoggingConfig.html) .", "stability": "external", "summary": "Creates a configuration for DNS query logging." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1373 }, "name": "queryLoggingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.QueryLoggingConfigProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-vpcs" }, "remarks": "> For public hosted zones, omit `VPCs` , `VPCId` , and `VPCRegion` .", "stability": "external", "summary": "*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1382 }, "name": "vpcs", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.VPCProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/route53.generated:CfnHostedZone" }, "@aws-cdk/aws-route53.CfnHostedZone.HostedZoneConfigProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzoneconfig.html", "exampleMetadata": "fixture=_generated" }, "remarks": "If you don't want to specify a comment, omit both the `HostedZoneConfig` and `Comment` elements.", "stability": "external", "summary": "A complex type that contains an optional comment about your hosted zone.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst hostedZoneConfigProperty: route53.CfnHostedZone.HostedZoneConfigProperty = {\n comment: 'comment',\n};" }, "fqn": "@aws-cdk/aws-route53.CfnHostedZone.HostedZoneConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1438 }, "name": "HostedZoneConfigProperty", "namespace": "CfnHostedZone", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzoneconfig.html#cfn-route53-hostedzone-hostedzoneconfig-comment" }, "stability": "external", "summary": "Any comments that you want to include about the hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1444 }, "name": "comment", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnHostedZone.HostedZoneConfigProperty" }, "@aws-cdk/aws-route53.CfnHostedZone.HostedZoneTagProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetag.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst hostedZoneTagProperty: route53.CfnHostedZone.HostedZoneTagProperty = {\n key: 'key',\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-route53.CfnHostedZone.HostedZoneTagProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1505 }, "name": "HostedZoneTagProperty", "namespace": "CfnHostedZone", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetag.html#cfn-route53-hostedzone-hostedzonetag-key" }, "remarks": "- *Add a tag to a health check or hosted zone* : `Key` is the name that you want to give the new tag.\n- *Edit a tag* : `Key` is the name of the tag that you want to change the `Value` for.\n- *Delete a key* : `Key` is the name of the tag you want to remove.\n- *Give a name to a health check* : Edit the default `Name` tag. In the Amazon Route 53 console, the list of your health checks includes a *Name* column that lets you see the name that you've given to each health check.", "stability": "external", "summary": "The value of `Key` depends on the operation that you want to perform:." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1516 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetag.html#cfn-route53-hostedzone-hostedzonetag-value" }, "remarks": "- *Add a tag to a health check or hosted zone* : `Value` is the value that you want to give the new tag.\n- *Edit a tag* : `Value` is the new value that you want to assign the tag.", "stability": "external", "summary": "The value of `Value` depends on the operation that you want to perform:." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1525 }, "name": "value", "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnHostedZone.HostedZoneTagProperty" }, "@aws-cdk/aws-route53.CfnHostedZone.QueryLoggingConfigProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-queryloggingconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A complex type that contains information about a configuration for DNS query logging.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst queryLoggingConfigProperty: route53.CfnHostedZone.QueryLoggingConfigProperty = {\n cloudWatchLogsLogGroupArn: 'cloudWatchLogsLogGroupArn',\n};" }, "fqn": "@aws-cdk/aws-route53.CfnHostedZone.QueryLoggingConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1591 }, "name": "QueryLoggingConfigProperty", "namespace": "CfnHostedZone", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-queryloggingconfig.html#cfn-route53-hostedzone-queryloggingconfig-cloudwatchlogsloggrouparn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1597 }, "name": "cloudWatchLogsLogGroupArn", "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnHostedZone.QueryLoggingConfigProperty" }, "@aws-cdk/aws-route53.CfnHostedZone.VPCProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-vpc.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Route 53 Resolver uses the records in the private hosted zone to route traffic in that VPC.\n\n> For public hosted zones, omit `VPCs` , `VPCId` , and `VPCRegion` .", "stability": "external", "summary": "*Private hosted zones only:* A complex type that contains information about an Amazon VPC.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst vPCProperty: route53.CfnHostedZone.VPCProperty = {\n vpcId: 'vpcId',\n vpcRegion: 'vpcRegion',\n};" }, "fqn": "@aws-cdk/aws-route53.CfnHostedZone.VPCProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1661 }, "name": "VPCProperty", "namespace": "CfnHostedZone", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-vpc.html#cfn-route53-hostedzone-vpc-vpcid" }, "remarks": "> For public hosted zones, omit `VPCs` , `VPCId` , and `VPCRegion` .", "stability": "external", "summary": "*Private hosted zones only:* The ID of an Amazon VPC." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1669 }, "name": "vpcId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-vpc.html#cfn-route53-hostedzone-vpc-vpcregion" }, "remarks": "> For public hosted zones, omit `VPCs` , `VPCId` , and `VPCRegion` .", "stability": "external", "summary": "*Private hosted zones only:* The region that an Amazon VPC was created in." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1677 }, "name": "vpcRegion", "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnHostedZone.VPCProperty" }, "@aws-cdk/aws-route53.CfnHostedZoneProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnHostedZone`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cfnHostedZoneProps: route53.CfnHostedZoneProps = {\n hostedZoneConfig: {\n comment: 'comment',\n },\n hostedZoneTags: [{\n key: 'key',\n value: 'value',\n }],\n name: 'name',\n queryLoggingConfig: {\n cloudWatchLogsLogGroupArn: 'cloudWatchLogsLogGroupArn',\n },\n vpcs: [{\n vpcId: 'vpcId',\n vpcRegion: 'vpcRegion',\n }],\n};" }, "fqn": "@aws-cdk/aws-route53.CfnHostedZoneProps", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1072 }, "name": "CfnHostedZoneProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzoneconfig" }, "remarks": "If you don't want to specify a comment, omit the `HostedZoneConfig` and `Comment` elements.", "stability": "external", "summary": "A complex type that contains an optional comment." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1081 }, "name": "hostedZoneConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.HostedZoneConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzonetags" }, "remarks": "For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *AWS Billing and Cost Management User Guide* .", "stability": "external", "summary": "Adds, edits, or deletes tags for a health check or a hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1090 }, "name": "hostedZoneTags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.HostedZoneTagProperty" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-name" }, "remarks": "Specify a fully qualified domain name, for example, *www.example.com* . The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical.\n\nIf you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of `NameServers` that are returned by the `Fn::GetAtt` intrinsic function.", "stability": "external", "summary": "The name of the domain." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1099 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-queryloggingconfig" }, "remarks": "After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.\n\nDNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:\n\n- Route 53 edge location that responded to the DNS query\n- Domain or subdomain that was requested\n- DNS record type, such as A or AAAA\n- DNS response code, such as `NoError` or `ServFail`\n\n- **Log Group and Resource Policy** - Before you create a query logging configuration, perform the following operations.\n\n> If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.\n\n- Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:\n\n- You must create the log group in the us-east-1 region.\n- You must use the same AWS account to create the log group and the hosted zone that you want to configure query logging for.\n- When you create log groups for query logging, we recommend that you use a consistent prefix, for example:\n\n`/aws/route53/ *hosted zone name*`\n\nIn the next step, you'll create a resource policy, which controls access to one or more log groups and the associated AWS resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.\n- Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of `Resource` , specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with `*` , for example:\n\n`arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*`\n\nTo avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values:\n\n- For `aws:SourceArn` , supply the hosted zone ARN used in creating the query logging configuration. For example, `aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID` .\n- For `aws:SourceAccount` , supply the account ID for the account that creates the query logging configuration. For example, `aws:SourceAccount:111111111111` .\n\nFor more information, see [The confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html) in the *AWS IAM User Guide* .\n\n> You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI .\n- **Log Streams and Edge Locations** - When Route 53 finishes creating the configuration for DNS query logging, it does the following:\n\n- Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.\n- Begins to send query logs to the applicable log stream.\n\nThe name of each log stream is in the following format:\n\n`*hosted zone ID* / *edge location code*`\n\nThe edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the [Route 53 Product Details](https://docs.aws.amazon.com/route53/details/) page.\n- **Queries That Are Logged** - Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see [Routing Internet Traffic to Your Website or Web Application](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html) in the *Amazon Route 53 Developer Guide* .\n- **Log File Format** - For a list of the values in each query log and the format of each value, see [Logging DNS Queries](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html) in the *Amazon Route 53 Developer Guide* .\n- **Pricing** - For information about charges for query logs, see [Amazon CloudWatch Pricing](https://docs.aws.amazon.com/cloudwatch/pricing/) .\n- **How to Stop Logging** - If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see [DeleteQueryLoggingConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteQueryLoggingConfig.html) .", "stability": "external", "summary": "Creates a configuration for DNS query logging." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1153 }, "name": "queryLoggingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.QueryLoggingConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-vpcs" }, "remarks": "> For public hosted zones, omit `VPCs` , `VPCId` , and `VPCRegion` .", "stability": "external", "summary": "*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1162 }, "name": "vpcs", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/aws-route53.CfnHostedZone.VPCProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/route53.generated:CfnHostedZoneProps" }, "@aws-cdk/aws-route53.CfnKeySigningKey": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Route53::KeySigningKey", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Route53::KeySigningKey` resource creates a new key-signing key (KSK) in a hosted zone. The hosted zone ID is passed as a parameter in the KSK properties. You can specify the properties of this KSK using the `Name` , `Status` , and `KeyManagementServiceArn` properties of the resource.", "stability": "external", "summary": "A CloudFormation `AWS::Route53::KeySigningKey`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cfnKeySigningKey = new route53.CfnKeySigningKey(this, 'MyCfnKeySigningKey', {\n hostedZoneId: 'hostedZoneId',\n keyManagementServiceArn: 'keyManagementServiceArn',\n name: 'name',\n status: 'status',\n});" }, "fqn": "@aws-cdk/aws-route53.CfnKeySigningKey", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Route53::KeySigningKey`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1917 }, "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.CfnKeySigningKeyProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1849 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1936 }, "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": 1950 }, "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": "CfnKeySigningKey", "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": 1853 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1941 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-hostedzoneid" }, "remarks": "For example: `Z00001111A1ABCaaABC11` .", "stability": "external", "summary": "The unique string (ID) that is used to identify a hosted zone." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1879 }, "name": "hostedZoneId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-keymanagementservicearn" }, "remarks": "The `KeyManagementServiceArn` must be unique for each key-signing key (KSK) in a single hosted zone. For example: `arn:aws:kms:us-east-1:111122223333:key/111a2222-a11b-1ab1-2ab2-1ab21a2b3a111` .", "stability": "external", "summary": "The Amazon resource name (ARN) for a customer managed customer master key (CMK) in AWS Key Management Service ( AWS KMS )." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1886 }, "name": "keyManagementServiceArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-name" }, "remarks": "`Name` can include numbers, letters, and underscores (_). `Name` must be unique for each key-signing key in the same hosted zone.", "stability": "external", "summary": "A string used to identify a key-signing key (KSK)." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1893 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-status" }, "remarks": "Status can have one of the following values:\n\n- **ACTIVE** - The KSK is being used for signing.\n- **INACTIVE** - The KSK is not being used for signing.\n- **DELETING** - The KSK is in the process of being deleted.\n- **ACTION_NEEDED** - There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed key might have been deleted, or the permissions for the customer managed key might have been changed.\n- **INTERNAL_FAILURE** - There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK.", "stability": "external", "summary": "A string that represents the current key-signing key (KSK) status." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1908 }, "name": "status", "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnKeySigningKey" }, "@aws-cdk/aws-route53.CfnKeySigningKeyProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnKeySigningKey`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cfnKeySigningKeyProps: route53.CfnKeySigningKeyProps = {\n hostedZoneId: 'hostedZoneId',\n keyManagementServiceArn: 'keyManagementServiceArn',\n name: 'name',\n status: 'status',\n};" }, "fqn": "@aws-cdk/aws-route53.CfnKeySigningKeyProps", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1742 }, "name": "CfnKeySigningKeyProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-hostedzoneid" }, "remarks": "For example: `Z00001111A1ABCaaABC11` .", "stability": "external", "summary": "The unique string (ID) that is used to identify a hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1749 }, "name": "hostedZoneId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-keymanagementservicearn" }, "remarks": "The `KeyManagementServiceArn` must be unique for each key-signing key (KSK) in a single hosted zone. For example: `arn:aws:kms:us-east-1:111122223333:key/111a2222-a11b-1ab1-2ab2-1ab21a2b3a111` .", "stability": "external", "summary": "The Amazon resource name (ARN) for a customer managed customer master key (CMK) in AWS Key Management Service ( AWS KMS )." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1756 }, "name": "keyManagementServiceArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-name" }, "remarks": "`Name` can include numbers, letters, and underscores (_). `Name` must be unique for each key-signing key in the same hosted zone.", "stability": "external", "summary": "A string used to identify a key-signing key (KSK)." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1763 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-status" }, "remarks": "Status can have one of the following values:\n\n- **ACTIVE** - The KSK is being used for signing.\n- **INACTIVE** - The KSK is not being used for signing.\n- **DELETING** - The KSK is in the process of being deleted.\n- **ACTION_NEEDED** - There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed key might have been deleted, or the permissions for the customer managed key might have been changed.\n- **INTERNAL_FAILURE** - There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK.", "stability": "external", "summary": "A string that represents the current key-signing key (KSK) status." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1778 }, "name": "status", "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnKeySigningKeyProps" }, "@aws-cdk/aws-route53.CfnRecordSet": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Route53::RecordSet", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Information about the record that you want to create.\n\nThe `AWS::Route53::RecordSet` type can be used as a standalone resource or as an embedded property in the `AWS::Route53::RecordSetGroup` type. Note that some `AWS::Route53::RecordSet` properties are valid only when used within `AWS::Route53::RecordSetGroup` .\n\nFor more information, see [ChangeResourceRecordSets](https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html) in the *Amazon Route 53 API Reference* .", "stability": "external", "summary": "A CloudFormation `AWS::Route53::RecordSet`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cfnRecordSet = new route53.CfnRecordSet(this, 'MyCfnRecordSet', {\n name: 'name',\n type: 'type',\n\n // the properties below are optional\n aliasTarget: {\n dnsName: 'dnsName',\n hostedZoneId: 'hostedZoneId',\n\n // the properties below are optional\n evaluateTargetHealth: false,\n },\n cidrRoutingConfig: {\n collectionId: 'collectionId',\n locationName: 'locationName',\n },\n comment: 'comment',\n failover: 'failover',\n geoLocation: {\n continentCode: 'continentCode',\n countryCode: 'countryCode',\n subdivisionCode: 'subdivisionCode',\n },\n healthCheckId: 'healthCheckId',\n hostedZoneId: 'hostedZoneId',\n hostedZoneName: 'hostedZoneName',\n multiValueAnswer: false,\n region: 'region',\n resourceRecords: ['resourceRecords'],\n setIdentifier: 'setIdentifier',\n ttl: 'ttl',\n weight: 123,\n});" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSet", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Route53::RecordSet`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2672 }, "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": 2356 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2701 }, "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": 2727 }, "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": 2360 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2706 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name" }, "remarks": "For `ListResourceRecordSets` responses, the name of a record in the specified hosted zone.\n\n*ChangeResourceRecordSets Only*\n\nEnter a fully qualified domain name, for example, `www.example.com` . You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats `www.example.com` (without a trailing dot) and `www.example.com.` (with a trailing dot) as identical.\n\nFor information about how to specify characters other than `a-z` , `0-9` , and `-` (hyphen) and how to specify internationalized domain names, see [DNS Domain Name Format](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) in the *Amazon Route 53 Developer Guide* .\n\nYou can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, `*.example.com` . Note the following:\n\n- The * must replace the entire label. For example, you can't specify `*prod.example.com` or `prod*.example.com` .\n- The * can't replace any of the middle labels, for example, marketing.*.example.com.\n- If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.\n\n> You can't use the * wildcard for resource records sets that have a type of NS.\n\nYou can use the * wildcard as the leftmost label in a domain name, for example, `*.example.com` . You can't use an * for one of the middle labels, for example, `marketing.*.example.com` . In addition, the * must replace the entire label; for example, you can't specify `prod*.example.com` .", "stability": "external", "summary": "For `ChangeResourceRecordSets` requests, the name of the record that you want to create, update, or delete." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2402 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type" }, "remarks": "For information about different record types and how data is encoded for them, see [Supported DNS Resource Record Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) in the *Amazon Route 53 Developer Guide* .\n\nValid values for basic resource record sets: `A` | `AAAA` | `CAA` | `CNAME` | `DS` | `MX` | `NAPTR` | `NS` | `PTR` | `SOA` | `SPF` | `SRV` | `TXT`\n\nValues for weighted, latency, geolocation, and failover resource record sets: `A` | `AAAA` | `CAA` | `CNAME` | `MX` | `NAPTR` | `PTR` | `SPF` | `SRV` | `TXT` . When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.\n\nValid values for multivalue answer resource record sets: `A` | `AAAA` | `MX` | `NAPTR` | `PTR` | `SPF` | `SRV` | `TXT`\n\n> SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of `Type` is `SPF` . RFC 7208, *Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1* , has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.\" In RFC 7208, see section 14.1, [The SPF DNS Record Type](https://docs.aws.amazon.com/http://tools.ietf.org/html/rfc7208#section-14.1) .\n\nValues for alias resource record sets:\n\n- *Amazon API Gateway custom regional APIs and edge-optimized APIs:* `A`\n- *CloudFront distributions:* `A`\n\nIf IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of `A` and one with a value of `AAAA` .\n- *Amazon API Gateway environment that has a regionalized subdomain* : `A`\n- *ELB load balancers:* `A` | `AAAA`\n- *Amazon S3 buckets:* `A`\n- *Amazon Virtual Private Cloud interface VPC endpoints* `A`\n- *Another resource record set in this hosted zone:* Specify the type of the resource record set that you're creating the alias for. All values are supported except `NS` and `SOA` .\n\n> If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of `Type` is `CNAME` . This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.", "stability": "external", "summary": "The DNS record type." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2431 }, "name": "type", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget" }, "remarks": "If you're creating resource records sets for a private hosted zone, note the following:\n\n- You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.\n- For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide* .", "stability": "external", "summary": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2443 }, "name": "aliasTarget", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSet.AliasTargetProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-cidrroutingconfig" }, "remarks": "A `LocationName` with an asterisk “*” can be used to create a default CIDR record. `CollectionId` is still required for default record.", "stability": "external", "summary": "The object that is specified in resource record set object when you are linking a resource record set to a CIDR location." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2452 }, "name": "cidrRoutingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSet.CidrRoutingConfigProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-comment" }, "stability": "external", "summary": "*Optional:* Any comments you want to include about a change batch request." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2459 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover" }, "remarks": "For one resource record set, you specify `PRIMARY` as the value for `Failover` ; for the other resource record set, you specify `SECONDARY` . In addition, you include the `HealthCheckId` element and specify the health check that you want Amazon Route 53 to perform for each resource record set.\n\nExcept where noted, the following failover behaviors assume that you have included the `HealthCheckId` element in both resource record sets:\n\n- When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.\n- When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.\n- When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.\n- If you omit the `HealthCheckId` element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.\n\nYou can't create non-failover resource record sets that have the same values for the `Name` and `Type` elements as failover resource record sets.\n\nFor failover alias resource record sets, you must also include the `EvaluateTargetHealth` element and set the value to true.\n\nFor more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide* :\n\n- [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)\n- [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)", "stability": "external", "summary": "*Failover resource record sets only:* To configure failover, you add the `Failover` element to two resource record sets." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2482 }, "name": "failover", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation" }, "remarks": "For example, if you want all queries from Africa to be routed to a web server with an IP address of `192.0.2.111` , create a resource record set with a `Type` of `A` and a `ContinentCode` of `AF` .\n\n> Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.\n\nIf you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.\n\nYou can't create two geolocation resource record sets that specify the same geographic location.\n\nThe value `*` in the `CountryCode` element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the `Name` and `Type` elements.\n\n> Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of `CountryCode` is `*` . Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a `*` resource record set, Route 53 returns a \"no answer\" response for queries from those locations.\n\nYou can't create non-geolocation resource record sets that have the same values for the `Name` and `Type` elements as geolocation resource record sets.", "stability": "external", "summary": "*Geolocation resource record sets only:* A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2501 }, "name": "geoLocation", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSet.GeoLocationProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid" }, "remarks": "Route 53 determines whether a resource record set is healthy based on one of the following:\n\n- By periodically sending a request to the endpoint that is specified in the health check\n- By aggregating the status of a specified group of health checks (calculated health checks)\n- By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)\n\n> Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the `Value` element. When you add a `HealthCheckId` element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check.\n\nFor more information, see the following topics in the *Amazon Route 53 Developer Guide* :\n\n- [How Amazon Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)\n- [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)\n- [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)\n\n*When to Specify HealthCheckId*\n\nSpecifying a value for `HealthCheckId` is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:\n\n- *Non-alias resource record sets* : You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.\n\nIf the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.\n\nIf the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.\n\nIf the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.\n- *Alias resource record sets* : You specify the following settings:\n\n- You set `EvaluateTargetHealth` to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).\n- You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.\n- You specify a health check ID for the non-alias resource record set.\n\nIf the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.\n\nIf the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.\n\n> The alias resource record set can also route traffic to a *group* of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.\n\n*Geolocation Routing*\n\nFor geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has `*` for `CountryCode` is `*` , which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:\n\n- The United States\n- North America\n- The default resource record set\n\n*Specifying the Health Check Endpoint by Domain Name*\n\nIf your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each `HTTP` server that is serving content for `www.example.com` . For the value of `FullyQualifiedDomainName` , specify the domain name of the server (such as `us-east-2-www.example.com` ), not the name of the resource record sets ( `www.example.com` ).\n\n> Health check results will be unpredictable if you do the following:\n>\n> - Create a health check that has the same value for `FullyQualifiedDomainName` as the name of a resource record set.\n> - Associate that health check with the resource record set.", "stability": "external", "summary": "If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the `HealthCheckId` element and specify the ID of the applicable health check." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2562 }, "name": "healthCheckId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid" }, "remarks": "Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .", "stability": "external", "summary": "The ID of the hosted zone that you want to create records in." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2571 }, "name": "hostedZoneId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename" }, "remarks": "You must include a trailing dot (for example, `www.example.com.` ) as part of the `HostedZoneName` .\n\nWhen you create a stack using an AWS::Route53::RecordSet that specifies `HostedZoneName` , AWS CloudFormation attempts to find a hosted zone whose name matches the HostedZoneName. If AWS CloudFormation cannot find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack.\n\nSpecify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .", "stability": "external", "summary": "The name of the hosted zone that you want to create records in." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2582 }, "name": "hostedZoneName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer" }, "remarks": "Note the following:\n\n- If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.\n- If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.\n- Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.\n- If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.\n- When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.\n- If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.\n\nYou can't create multivalue answer alias records.", "stability": "external", "summary": "*Multivalue answer resource record sets only* : To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify `true` for `MultiValueAnswer` ." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2598 }, "name": "multiValueAnswer", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region" }, "remarks": "The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.\n\nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.\n\nNote the following:\n\n- You can only specify one `ResourceRecord` per latency resource record set.\n- You can only create one latency resource record set for each Amazon EC2 Region.\n- You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.\n- You can't create non-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets.", "stability": "external", "summary": "*Latency-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2614 }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords" }, "remarks": "For example, if you specified `A` for `Type` , you specify one or more IP addresses in IPv4 format for `ResourceRecords` . For information about the format of values for each record type, see [Supported DNS Resource Record Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) in the *Amazon Route 53 Developer Guide* .\n\nNote the following:\n\n- You can specify more than one value for all record types except CNAME and SOA.\n- The maximum length of a value is 4000 characters.\n- If you're creating an alias record, omit `ResourceRecords` .", "stability": "external", "summary": "One or more values that correspond with the value that you specified for the `Type` property." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2627 }, "name": "resourceRecords", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier" }, "remarks": "For information about routing policies, see [Choosing a Routing Policy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) in the *Amazon Route 53 Developer Guide* .", "stability": "external", "summary": "*Resource record sets that have a routing policy other than simple:* An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of `SetIdentifier` must be unique for each resource record set." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2636 }, "name": "setIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl" }, "remarks": "- If you're creating or updating an alias resource record set, omit `TTL` . Amazon Route 53 uses the value of `TTL` for the alias target.\n- If you're associating this resource record set with a health check (if you're adding a `HealthCheckId` element), we recommend that you specify a `TTL` of 60 seconds or less so clients respond quickly to changes in health status.\n- All of the resource record sets in a group of weighted resource record sets must have the same value for `TTL` .\n- If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a `TTL` of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for `Weight` .", "stability": "external", "summary": "The resource record cache time to live (TTL), in seconds. Note the following:." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2648 }, "name": "ttl", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight" }, "remarks": "Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:\n\n- You must specify a value for the `Weight` element for every weighted resource record set.\n- You can only specify one `ResourceRecord` per weighted resource record set.\n- You can't create latency, failover, or geolocation resource record sets that have the same values for the `Name` and `Type` elements as weighted resource record sets.\n- You can create a maximum of 100 weighted resource record sets that have the same values for the `Name` and `Type` elements.\n- For weighted (but not weighted alias) resource record sets, if you set `Weight` to `0` for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set `Weight` to `0` for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.\n\nThe effect of setting `Weight` to `0` is different when you associate health checks with weighted resource record sets. For more information, see [Options for Configuring Route 53 Active-Active and Active-Passive Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html) in the *Amazon Route 53 Developer Guide* .", "stability": "external", "summary": "*Weighted resource record sets only:* Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2663 }, "name": "weight", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/route53.generated:CfnRecordSet" }, "@aws-cdk/aws-route53.CfnRecordSet.AliasTargetProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html", "exampleMetadata": "fixture=_generated" }, "remarks": "When creating records for a private hosted zone, note the following:\n\n- Creating geolocation alias and latency alias records in a private hosted zone is allowed but not supported.\n- For information about creating failover records in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) .", "stability": "external", "summary": "*Alias records only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst aliasTargetProperty: route53.CfnRecordSet.AliasTargetProperty = {\n dnsName: 'dnsName',\n hostedZoneId: 'hostedZoneId',\n\n // the properties below are optional\n evaluateTargetHealth: false,\n};" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSet.AliasTargetProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2746 }, "name": "AliasTargetProperty", "namespace": "CfnRecordSet", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname" }, "remarks": "- **Amazon API Gateway custom regional APIs and edge-optimized APIs** - Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command [get-domain-names](https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html) :\n\n- For regional APIs, specify the value of `regionalDomainName` .\n- For edge-optimized APIs, specify the value of `distributionDomainName` . This is the name of the associated CloudFront distribution, such as `da1b2c3d4e5.cloudfront.net` .\n\n> The name of the record that you're creating must match a custom domain name for your API, such as `api.example.com` .\n- **Amazon Virtual Private Cloud interface VPC endpoint** - Enter the API endpoint for the interface endpoint, such as `vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com` . For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of `DnsName` using the AWS CLI command [describe-vpc-endpoints](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html) .\n- **CloudFront distribution** - Specify the domain name that CloudFront assigned when you created your distribution.\n\nYour CloudFront distribution must include an alternate domain name that matches the name of the record. For example, if the name of the record is *acme.example.com* , your CloudFront distribution must include *acme.example.com* as one of the alternate domain names. For more information, see [Using Alternate Domain Names (CNAMEs)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html) in the *Amazon CloudFront Developer Guide* .\n\nYou can't create a record in a private hosted zone to route traffic to a CloudFront distribution.\n\n> For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.\n- **Elastic Beanstalk environment** - If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name `my-environment. *us-west-2* .elasticbeanstalk.com` is a regionalized domain name.\n\n> For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.\n\nFor Elastic Beanstalk environments that have regionalized subdomains, specify the `CNAME` attribute for the environment. You can use the following methods to get the value of the CNAME attribute:\n\n- *AWS Management Console* : For information about how to get the value by using the console, see [Using Custom Domains with AWS Elastic Beanstalk](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html) in the *AWS Elastic Beanstalk Developer Guide* .\n- *Elastic Beanstalk API* : Use the `DescribeEnvironments` action to get the value of the `CNAME` attribute. For more information, see [DescribeEnvironments](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html) in the *AWS Elastic Beanstalk API Reference* .\n- *AWS CLI* : Use the `describe-environments` command to get the value of the `CNAME` attribute. For more information, see [describe-environments](https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html) in the *AWS CLI* .\n- **ELB load balancer** - Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console , the ELB API, or the AWS CLI .\n\n- *AWS Management Console* : Go to the EC2 page, choose *Load Balancers* in the navigation pane, choose the load balancer, choose the *Description* tab, and get the value of the *DNS name* field.\n\nIf you're routing traffic to a Classic Load Balancer, get the value that begins with *dualstack* . If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.\n- *Elastic Load Balancing API* : Use `DescribeLoadBalancers` to get the value of `DNSName` . For more information, see the applicable guide:\n\n- Classic Load Balancers: [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html)\n- Application and Network Load Balancers: [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html)\n- *CloudFormation Fn::GetAtt intrinsic function* : Use the [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) intrinsic function to get the value of `DNSName` :\n\n- [Classic Load Balancers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#aws-properties-ec2-elb-return-values) .\n- [Application and Network Load Balancers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#aws-resource-elasticloadbalancingv2-loadbalancer-return-values) .\n- *AWS CLI* : Use `describe-load-balancers` to get the value of `DNSName` . For more information, see the applicable guide:\n\n- Classic Load Balancers: [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html)\n- Application and Network Load Balancers: [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html)\n- **Global Accelerator accelerator** - Specify the DNS name for your accelerator:\n\n- *Global Accelerator API* : To get the DNS name, use [DescribeAccelerator](https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html) .\n- *AWS CLI* : To get the DNS name, use [describe-accelerator](https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html) .\n- **Amazon S3 bucket that is configured as a static website** - Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, `s3-website.us-east-2.amazonaws.com` . For more information about valid values, see the table [Amazon S3 Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints) in the *Amazon Web Services General Reference* . For more information about using S3 buckets for websites, see [Getting Started with Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html) in the *Amazon Route 53 Developer Guide.*\n- **Another Route 53 record** - Specify the value of the `Name` element for a record in the current hosted zone.\n\n> If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of `Type` is `CNAME` . This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.", "stability": "external", "summary": "*Alias records only:* The value that you specify depends on where you want to route queries:." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2801 }, "name": "dnsName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid" }, "remarks": "- **Amazon API Gateway custom regional APIs and edge-optimized APIs** - Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command [get-domain-names](https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html) :\n\n- For regional APIs, specify the value of `regionalHostedZoneId` .\n- For edge-optimized APIs, specify the value of `distributionHostedZoneId` .\n- **Amazon Virtual Private Cloud interface VPC endpoint** - Specify the hosted zone ID for your interface endpoint. You can get the value of `HostedZoneId` using the AWS CLI command [describe-vpc-endpoints](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html) .\n- **CloudFront distribution** - Specify `Z2FDTNDATAQYW2` . This is always the hosted zone ID when you create an alias record that routes traffic to a CloudFront distribution.\n\n> Alias records for CloudFront can't be created in a private zone.\n- **Elastic Beanstalk environment** - Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see [AWS Elastic Beanstalk endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html) in the *Amazon Web Services General Reference* .\n- **ELB load balancer** - Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:\n\n- [Service Endpoints](https://docs.aws.amazon.com/general/latest/gr/elb.html) table in the \"Elastic Load Balancing Endpoints and Quotas\" topic in the *Amazon Web Services General Reference* : Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.\n- *AWS Management Console* : Go to the Amazon EC2 page, choose *Load Balancers* in the navigation pane, select the load balancer, and get the value of the *Hosted zone* field on the *Description* tab.\n- *Elastic Load Balancing API* : Use `DescribeLoadBalancers` to get the applicable value. For more information, see the applicable guide:\n\n- Classic Load Balancers: Use [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html) to get the value of `CanonicalHostedZoneNameID` .\n- Application and Network Load Balancers: Use [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) to get the value of `CanonicalHostedZoneID` .\n- *CloudFormation Fn::GetAtt intrinsic function* : Use the [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) intrinsic function to get the applicable value:\n\n- Classic Load Balancers: Get [CanonicalHostedZoneNameID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#aws-properties-ec2-elb-return-values) .\n- Application and Network Load Balancers: Get [CanonicalHostedZoneID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#aws-resource-elasticloadbalancingv2-loadbalancer-return-values) .\n- *AWS CLI* : Use `describe-load-balancers` to get the applicable value. For more information, see the applicable guide:\n\n- Classic Load Balancers: Use [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html) to get the value of `CanonicalHostedZoneNameID` .\n- Application and Network Load Balancers: Use [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html) to get the value of `CanonicalHostedZoneID` .\n- **Global Accelerator accelerator** - Specify `Z2BJ6XQ5FK7U4H` .\n- **An Amazon S3 bucket configured as a static website** - Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table [Amazon S3 Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints) in the *Amazon Web Services General Reference* .\n- **Another Route 53 record in your hosted zone** - Specify the hosted zone ID of your hosted zone. (An alias record can't reference a record in a different hosted zone.)", "stability": "external", "summary": "*Alias resource records sets only* : The value used depends on where you want to route traffic:." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2862 }, "name": "hostedZoneId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth" }, "remarks": "Note the following:\n\n- **CloudFront distributions** - You can't set `EvaluateTargetHealth` to `true` when the alias target is a CloudFront distribution.\n- **Elastic Beanstalk environments that have regionalized subdomains** - If you specify an Elastic Beanstalk environment in `DNSName` and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set `EvaluateTargetHealth` to `true` and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.\n\nIf the environment contains a single Amazon EC2 instance, there are no special requirements.\n- **ELB load balancers** - Health checking behavior depends on the type of load balancer:\n\n- *Classic Load Balancers* : If you specify an ELB Classic Load Balancer in `DNSName` , Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set `EvaluateTargetHealth` to `true` and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.\n- *Application and Network Load Balancers* : If you specify an ELB Application or Network Load Balancer and you set `EvaluateTargetHealth` to `true` , Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:\n\n- For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.\n- A target group that has no registered targets is considered unhealthy.\n\n> When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.\n- **S3 buckets** - There are no special requirements for setting `EvaluateTargetHealth` to `true` when the alias target is an S3 bucket.\n- **Other records in the same hosted zone** - If the AWS resource that you specify in `DNSName` is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see [What Happens When You Omit Health Checks?](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting) in the *Amazon Route 53 Developer Guide* .\n\nFor more information and examples, see [Amazon Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) in the *Amazon Route 53 Developer Guide* .", "stability": "external", "summary": "*Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets:* When `EvaluateTargetHealth` is `true` , an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2827 }, "name": "evaluateTargetHealth", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/route53.generated:CfnRecordSet.AliasTargetProperty" }, "@aws-cdk/aws-route53.CfnRecordSet.CidrRoutingConfigProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html", "exampleMetadata": "fixture=_generated" }, "remarks": "A `LocationName` with an asterisk “*” can be used to create a default CIDR record. `CollectionId` is still required for default record.", "stability": "external", "summary": "The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cidrRoutingConfigProperty: route53.CfnRecordSet.CidrRoutingConfigProperty = {\n collectionId: 'collectionId',\n locationName: 'locationName',\n};" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSet.CidrRoutingConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2933 }, "name": "CidrRoutingConfigProperty", "namespace": "CfnRecordSet", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html#cfn-route53-cidrroutingconfig-collectionid" }, "stability": "external", "summary": "The CIDR collection ID." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2939 }, "name": "collectionId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html#cfn-route53-cidrroutingconfig-locationname" }, "stability": "external", "summary": "The CIDR collection location name." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2945 }, "name": "locationName", "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnRecordSet.CidrRoutingConfigProperty" }, "@aws-cdk/aws-route53.CfnRecordSet.GeoLocationProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A complex type that contains information about a geographic location.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst geoLocationProperty: route53.CfnRecordSet.GeoLocationProperty = {\n continentCode: 'continentCode',\n countryCode: 'countryCode',\n subdivisionCode: 'subdivisionCode',\n};" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSet.GeoLocationProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3011 }, "name": "GeoLocationProperty", "namespace": "CfnRecordSet", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-continentcode" }, "remarks": "- *AF* : Africa\n- *AN* : Antarctica\n- *AS* : Asia\n- *EU* : Europe\n- *OC* : Oceania\n- *NA* : North America\n- *SA* : South America\n\nConstraint: Specifying `ContinentCode` with either `CountryCode` or `SubdivisionCode` returns an `InvalidInput` error.", "stability": "external", "summary": "For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Route 53 supports the following continent codes:." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3027 }, "name": "continentCode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode" }, "remarks": "Route 53 uses the two-letter country codes that are specified in [ISO standard 3166-1 alpha-2](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) .", "stability": "external", "summary": "For geolocation resource record sets, the two-letter code for a country." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3035 }, "name": "countryCode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode" }, "remarks": "Route 53 doesn't support any other values for `SubdivisionCode` . For a list of state abbreviations, see [Appendix B: Two–Letter State and Possession Abbreviations](https://docs.aws.amazon.com/https://pe.usps.com/text/pub28/28apb.htm) on the United States Postal Service website.\n\nIf you specify `subdivisioncode` , you must also specify `US` for `CountryCode` .", "stability": "external", "summary": "For geolocation resource record sets, the two-letter code for a state of the United States." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3043 }, "name": "subdivisionCode", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnRecordSet.GeoLocationProperty" }, "@aws-cdk/aws-route53.CfnRecordSetGroup": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Route53::RecordSetGroup", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html", "exampleMetadata": "fixture=_generated" }, "remarks": "A complex type that contains an optional comment, the name and ID of the hosted zone that you want to make changes in, and values for the records that you want to create.", "stability": "external", "summary": "A CloudFormation `AWS::Route53::RecordSetGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cfnRecordSetGroup = new route53.CfnRecordSetGroup(this, 'MyCfnRecordSetGroup', /* all optional props */ {\n comment: 'comment',\n hostedZoneId: 'hostedZoneId',\n hostedZoneName: 'hostedZoneName',\n recordSets: [{\n name: 'name',\n type: 'type',\n\n // the properties below are optional\n aliasTarget: {\n dnsName: 'dnsName',\n hostedZoneId: 'hostedZoneId',\n\n // the properties below are optional\n evaluateTargetHealth: false,\n },\n cidrRoutingConfig: {\n collectionId: 'collectionId',\n locationName: 'locationName',\n },\n failover: 'failover',\n geoLocation: {\n continentCode: 'continentCode',\n countryCode: 'countryCode',\n subdivisionCode: 'subdivisionCode',\n },\n healthCheckId: 'healthCheckId',\n hostedZoneId: 'hostedZoneId',\n hostedZoneName: 'hostedZoneName',\n multiValueAnswer: false,\n region: 'region',\n resourceRecords: ['resourceRecords'],\n setIdentifier: 'setIdentifier',\n ttl: 'ttl',\n weight: 123,\n }],\n});" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Route53::RecordSetGroup`." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3276 }, "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": 3210 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3291 }, "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": 3305 }, "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": 3214 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3296 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-comment" }, "stability": "external", "summary": "*Optional:* Any comments you want to include about a change batch request." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3240 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzoneid" }, "remarks": "Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .", "stability": "external", "summary": "The ID of the hosted zone that you want to create records in." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3249 }, "name": "hostedZoneId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzonename" }, "remarks": "You must include a trailing dot (for example, `www.example.com.` ) as part of the `HostedZoneName` .\n\nWhen you create a stack using an `AWS::Route53::RecordSet` that specifies `HostedZoneName` , AWS CloudFormation attempts to find a hosted zone whose name matches the `HostedZoneName` . If AWS CloudFormation can't find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack.\n\nSpecify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .", "stability": "external", "summary": "The name of the hosted zone that you want to create records in." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3260 }, "name": "hostedZoneName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-recordsets" }, "stability": "external", "summary": "A complex type that contains one `RecordSet` element for each record that you want to create." }, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3267 }, "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" } } ] } } } ], "symbolId": "lib/route53.generated:CfnRecordSetGroup" }, "@aws-cdk/aws-route53.CfnRecordSetGroup.AliasTargetProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html", "exampleMetadata": "fixture=_generated" }, "remarks": "When creating records for a private hosted zone, note the following:\n\n- Creating geolocation alias and latency alias records in a private hosted zone is allowed but not supported.\n- For information about creating failover records in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) .", "stability": "external", "summary": "*Alias records only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst aliasTargetProperty: route53.CfnRecordSetGroup.AliasTargetProperty = {\n dnsName: 'dnsName',\n hostedZoneId: 'hostedZoneId',\n\n // the properties below are optional\n evaluateTargetHealth: false,\n};" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup.AliasTargetProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3324 }, "name": "AliasTargetProperty", "namespace": "CfnRecordSetGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname" }, "remarks": "- **Amazon API Gateway custom regional APIs and edge-optimized APIs** - Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command [get-domain-names](https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html) :\n\n- For regional APIs, specify the value of `regionalDomainName` .\n- For edge-optimized APIs, specify the value of `distributionDomainName` . This is the name of the associated CloudFront distribution, such as `da1b2c3d4e5.cloudfront.net` .\n\n> The name of the record that you're creating must match a custom domain name for your API, such as `api.example.com` .\n- **Amazon Virtual Private Cloud interface VPC endpoint** - Enter the API endpoint for the interface endpoint, such as `vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com` . For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of `DnsName` using the AWS CLI command [describe-vpc-endpoints](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html) .\n- **CloudFront distribution** - Specify the domain name that CloudFront assigned when you created your distribution.\n\nYour CloudFront distribution must include an alternate domain name that matches the name of the record. For example, if the name of the record is *acme.example.com* , your CloudFront distribution must include *acme.example.com* as one of the alternate domain names. For more information, see [Using Alternate Domain Names (CNAMEs)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html) in the *Amazon CloudFront Developer Guide* .\n\nYou can't create a record in a private hosted zone to route traffic to a CloudFront distribution.\n\n> For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.\n- **Elastic Beanstalk environment** - If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name `my-environment. *us-west-2* .elasticbeanstalk.com` is a regionalized domain name.\n\n> For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.\n\nFor Elastic Beanstalk environments that have regionalized subdomains, specify the `CNAME` attribute for the environment. You can use the following methods to get the value of the CNAME attribute:\n\n- *AWS Management Console* : For information about how to get the value by using the console, see [Using Custom Domains with AWS Elastic Beanstalk](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html) in the *AWS Elastic Beanstalk Developer Guide* .\n- *Elastic Beanstalk API* : Use the `DescribeEnvironments` action to get the value of the `CNAME` attribute. For more information, see [DescribeEnvironments](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html) in the *AWS Elastic Beanstalk API Reference* .\n- *AWS CLI* : Use the `describe-environments` command to get the value of the `CNAME` attribute. For more information, see [describe-environments](https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html) in the *AWS CLI* .\n- **ELB load balancer** - Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console , the ELB API, or the AWS CLI .\n\n- *AWS Management Console* : Go to the EC2 page, choose *Load Balancers* in the navigation pane, choose the load balancer, choose the *Description* tab, and get the value of the *DNS name* field.\n\nIf you're routing traffic to a Classic Load Balancer, get the value that begins with *dualstack* . If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.\n- *Elastic Load Balancing API* : Use `DescribeLoadBalancers` to get the value of `DNSName` . For more information, see the applicable guide:\n\n- Classic Load Balancers: [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html)\n- Application and Network Load Balancers: [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html)\n- *CloudFormation Fn::GetAtt intrinsic function* : Use the [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) intrinsic function to get the value of `DNSName` :\n\n- [Classic Load Balancers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#aws-properties-ec2-elb-return-values) .\n- [Application and Network Load Balancers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#aws-resource-elasticloadbalancingv2-loadbalancer-return-values) .\n- *AWS CLI* : Use `describe-load-balancers` to get the value of `DNSName` . For more information, see the applicable guide:\n\n- Classic Load Balancers: [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html)\n- Application and Network Load Balancers: [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html)\n- **Global Accelerator accelerator** - Specify the DNS name for your accelerator:\n\n- *Global Accelerator API* : To get the DNS name, use [DescribeAccelerator](https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html) .\n- *AWS CLI* : To get the DNS name, use [describe-accelerator](https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html) .\n- **Amazon S3 bucket that is configured as a static website** - Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, `s3-website.us-east-2.amazonaws.com` . For more information about valid values, see the table [Amazon S3 Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints) in the *Amazon Web Services General Reference* . For more information about using S3 buckets for websites, see [Getting Started with Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html) in the *Amazon Route 53 Developer Guide.*\n- **Another Route 53 record** - Specify the value of the `Name` element for a record in the current hosted zone.\n\n> If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of `Type` is `CNAME` . This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.", "stability": "external", "summary": "*Alias records only:* The value that you specify depends on where you want to route queries:." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3379 }, "name": "dnsName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid" }, "remarks": "- **Amazon API Gateway custom regional APIs and edge-optimized APIs** - Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command [get-domain-names](https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html) :\n\n- For regional APIs, specify the value of `regionalHostedZoneId` .\n- For edge-optimized APIs, specify the value of `distributionHostedZoneId` .\n- **Amazon Virtual Private Cloud interface VPC endpoint** - Specify the hosted zone ID for your interface endpoint. You can get the value of `HostedZoneId` using the AWS CLI command [describe-vpc-endpoints](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html) .\n- **CloudFront distribution** - Specify `Z2FDTNDATAQYW2` . This is always the hosted zone ID when you create an alias record that routes traffic to a CloudFront distribution.\n\n> Alias records for CloudFront can't be created in a private zone.\n- **Elastic Beanstalk environment** - Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see [AWS Elastic Beanstalk endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html) in the *Amazon Web Services General Reference* .\n- **ELB load balancer** - Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:\n\n- [Service Endpoints](https://docs.aws.amazon.com/general/latest/gr/elb.html) table in the \"Elastic Load Balancing endpoints and quotas\" topic in the *Amazon Web Services General Reference* : Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.\n- *AWS Management Console* : Go to the Amazon EC2 page, choose *Load Balancers* in the navigation pane, select the load balancer, and get the value of the *Hosted zone* field on the *Description* tab.\n- *Elastic Load Balancing API* : Use `DescribeLoadBalancers` to get the applicable value. For more information, see the applicable guide:\n\n- Classic Load Balancers: Use [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html) to get the value of `CanonicalHostedZoneNameID` .\n- Application and Network Load Balancers: Use [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) to get the value of `CanonicalHostedZoneID` .\n- *CloudFormation Fn::GetAtt intrinsic function* : Use the [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) intrinsic function to get the applicable value:\n\n- Classic Load Balancers: Get [CanonicalHostedZoneNameID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#aws-properties-ec2-elb-return-values) .\n- Application and Network Load Balancers: Get [CanonicalHostedZoneID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#aws-resource-elasticloadbalancingv2-loadbalancer-return-values) .\n- *AWS CLI* : Use `describe-load-balancers` to get the applicable value. For more information, see the applicable guide:\n\n- Classic Load Balancers: Use [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html) to get the value of `CanonicalHostedZoneNameID` .\n- Application and Network Load Balancers: Use [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html) to get the value of `CanonicalHostedZoneID` .\n- **Global Accelerator accelerator** - Specify `Z2BJ6XQ5FK7U4H` .\n- **An Amazon S3 bucket configured as a static website** - Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table [Amazon S3 Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints) in the *Amazon Web Services General Reference* .\n- **Another Route 53 record in your hosted zone** - Specify the hosted zone ID of your hosted zone. (An alias record can't reference a record in a different hosted zone.)", "stability": "external", "summary": "*Alias resource records sets only* : The value used depends on where you want to route traffic:." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3440 }, "name": "hostedZoneId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth" }, "remarks": "Note the following:\n\n- **CloudFront distributions** - You can't set `EvaluateTargetHealth` to `true` when the alias target is a CloudFront distribution.\n- **Elastic Beanstalk environments that have regionalized subdomains** - If you specify an Elastic Beanstalk environment in `DNSName` and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set `EvaluateTargetHealth` to `true` and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.\n\nIf the environment contains a single Amazon EC2 instance, there are no special requirements.\n- **ELB load balancers** - Health checking behavior depends on the type of load balancer:\n\n- *Classic Load Balancers* : If you specify an ELB Classic Load Balancer in `DNSName` , Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set `EvaluateTargetHealth` to `true` and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.\n- *Application and Network Load Balancers* : If you specify an ELB Application or Network Load Balancer and you set `EvaluateTargetHealth` to `true` , Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:\n\n- For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.\n- A target group that has no registered targets is considered unhealthy.\n\n> When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.\n- **S3 buckets** - There are no special requirements for setting `EvaluateTargetHealth` to `true` when the alias target is an S3 bucket.\n- **Other records in the same hosted zone** - If the AWS resource that you specify in `DNSName` is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see [What Happens When You Omit Health Checks?](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting) in the *Amazon Route 53 Developer Guide* .\n\nFor more information and examples, see [Amazon Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) in the *Amazon Route 53 Developer Guide* .", "stability": "external", "summary": "*Applies only to alias records with any routing policy:* When `EvaluateTargetHealth` is `true` , an alias record inherits the health of the referenced AWS resource, such as an ELB load balancer or another record in the hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3405 }, "name": "evaluateTargetHealth", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/route53.generated:CfnRecordSetGroup.AliasTargetProperty" }, "@aws-cdk/aws-route53.CfnRecordSetGroup.CidrRoutingConfigProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html", "exampleMetadata": "fixture=_generated" }, "remarks": "A `LocationName` with an asterisk “*” can be used to create a default CIDR record. `CollectionId` is still required for default record.", "stability": "external", "summary": "The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cidrRoutingConfigProperty: route53.CfnRecordSetGroup.CidrRoutingConfigProperty = {\n collectionId: 'collectionId',\n locationName: 'locationName',\n};" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup.CidrRoutingConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3511 }, "name": "CidrRoutingConfigProperty", "namespace": "CfnRecordSetGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html#cfn-route53-cidrroutingconfig-collectionid" }, "stability": "external", "summary": "The CIDR collection ID." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3517 }, "name": "collectionId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html#cfn-route53-cidrroutingconfig-locationname" }, "stability": "external", "summary": "The CIDR collection location name." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3523 }, "name": "locationName", "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnRecordSetGroup.CidrRoutingConfigProperty" }, "@aws-cdk/aws-route53.CfnRecordSetGroup.GeoLocationProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A complex type that contains information about a geographic location.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst geoLocationProperty: route53.CfnRecordSetGroup.GeoLocationProperty = {\n continentCode: 'continentCode',\n countryCode: 'countryCode',\n subdivisionCode: 'subdivisionCode',\n};" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup.GeoLocationProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3589 }, "name": "GeoLocationProperty", "namespace": "CfnRecordSetGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordsetgroup-geolocation-continentcode" }, "remarks": "- *AF* : Africa\n- *AN* : Antarctica\n- *AS* : Asia\n- *EU* : Europe\n- *OC* : Oceania\n- *NA* : North America\n- *SA* : South America\n\nConstraint: Specifying `ContinentCode` with either `CountryCode` or `SubdivisionCode` returns an `InvalidInput` error.", "stability": "external", "summary": "For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Route 53 supports the following continent codes:." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3605 }, "name": "continentCode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode" }, "remarks": "Route 53 uses the two-letter country codes that are specified in [ISO standard 3166-1 alpha-2](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) .", "stability": "external", "summary": "For geolocation resource record sets, the two-letter code for a country." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3613 }, "name": "countryCode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode" }, "remarks": "Route 53 doesn't support any other values for `SubdivisionCode` . For a list of state abbreviations, see [Appendix B: Two–Letter State and Possession Abbreviations](https://docs.aws.amazon.com/https://pe.usps.com/text/pub28/28apb.htm) on the United States Postal Service website.\n\nIf you specify `subdivisioncode` , you must also specify `US` for `CountryCode` .", "stability": "external", "summary": "For geolocation resource record sets, the two-letter code for a state of the United States." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3621 }, "name": "subdivisionCode", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/route53.generated:CfnRecordSetGroup.GeoLocationProperty" }, "@aws-cdk/aws-route53.CfnRecordSetGroup.RecordSetProperty": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Information about one record that you want to create.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst recordSetProperty: route53.CfnRecordSetGroup.RecordSetProperty = {\n name: 'name',\n type: 'type',\n\n // the properties below are optional\n aliasTarget: {\n dnsName: 'dnsName',\n hostedZoneId: 'hostedZoneId',\n\n // the properties below are optional\n evaluateTargetHealth: false,\n },\n cidrRoutingConfig: {\n collectionId: 'collectionId',\n locationName: 'locationName',\n },\n failover: 'failover',\n geoLocation: {\n continentCode: 'continentCode',\n countryCode: 'countryCode',\n subdivisionCode: 'subdivisionCode',\n },\n healthCheckId: 'healthCheckId',\n hostedZoneId: 'hostedZoneId',\n hostedZoneName: 'hostedZoneName',\n multiValueAnswer: false,\n region: 'region',\n resourceRecords: ['resourceRecords'],\n setIdentifier: 'setIdentifier',\n ttl: 'ttl',\n weight: 123,\n};" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup.RecordSetProperty", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3688 }, "name": "RecordSetProperty", "namespace": "CfnRecordSetGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name" }, "remarks": "For `ListResourceRecordSets` responses, the name of a record in the specified hosted zone.\n\n*ChangeResourceRecordSets Only*\n\nEnter a fully qualified domain name, for example, `www.example.com` . You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats `www.example.com` (without a trailing dot) and `www.example.com.` (with a trailing dot) as identical.\n\nFor information about how to specify characters other than `a-z` , `0-9` , and `-` (hyphen) and how to specify internationalized domain names, see [DNS Domain Name Format](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) in the *Amazon Route 53 Developer Guide* .\n\nYou can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, `*.example.com` . Note the following:\n\n- The * must replace the entire label. For example, you can't specify `*prod.example.com` or `prod*.example.com` .\n- The * can't replace any of the middle labels, for example, marketing.*.example.com.\n- If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.\n\n> You can't use the * wildcard for resource records sets that have a type of NS.\n\nYou can use the * wildcard as the leftmost label in a domain name, for example, `*.example.com` . You can't use an * for one of the middle labels, for example, `marketing.*.example.com` . In addition, the * must replace the entire label; for example, you can't specify `prod*.example.com` .", "stability": "external", "summary": "For `ChangeResourceRecordSets` requests, the name of the record that you want to create, update, or delete." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3860 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type" }, "remarks": "For information about different record types and how data is encoded for them, see [Supported DNS Resource Record Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) in the *Amazon Route 53 Developer Guide* .\n\nValid values for basic resource record sets: `A` | `AAAA` | `CAA` | `CNAME` | `DS` | `MX` | `NAPTR` | `NS` | `PTR` | `SOA` | `SPF` | `SRV` | `TXT`\n\nValues for weighted, latency, geolocation, and failover resource record sets: `A` | `AAAA` | `CAA` | `CNAME` | `MX` | `NAPTR` | `PTR` | `SPF` | `SRV` | `TXT` . When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.\n\nValid values for multivalue answer resource record sets: `A` | `AAAA` | `MX` | `NAPTR` | `PTR` | `SPF` | `SRV` | `TXT`\n\n> SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of `Type` is `SPF` . RFC 7208, *Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1* , has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.\" In RFC 7208, see section 14.1, [The SPF DNS Record Type](https://docs.aws.amazon.com/http://tools.ietf.org/html/rfc7208#section-14.1) .\n\nValues for alias resource record sets:\n\n- *Amazon API Gateway custom regional APIs and edge-optimized APIs:* `A`\n- *CloudFront distributions:* `A`\n\nIf IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of `A` and one with a value of `AAAA` .\n- *Amazon API Gateway environment that has a regionalized subdomain* : `A`\n- *ELB load balancers:* `A` | `AAAA`\n- *Amazon S3 buckets:* `A`\n- *Amazon Virtual Private Cloud interface VPC endpoints* `A`\n- *Another resource record set in this hosted zone:* Specify the type of the resource record set that you're creating the alias for. All values are supported except `NS` and `SOA` .\n\n> If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of `Type` is `CNAME` . This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.", "stability": "external", "summary": "The DNS record type." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3928 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget" }, "remarks": "If you're creating resource records sets for a private hosted zone, note the following:\n\n- You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.\n- For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide* .", "stability": "external", "summary": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3699 }, "name": "aliasTarget", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup.AliasTargetProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-cidrroutingconfig" }, "stability": "external", "summary": "`CfnRecordSetGroup.RecordSetProperty.CidrRoutingConfig`." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3705 }, "name": "cidrRoutingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup.CidrRoutingConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover" }, "remarks": "For one resource record set, you specify `PRIMARY` as the value for `Failover` ; for the other resource record set, you specify `SECONDARY` . In addition, you include the `HealthCheckId` element and specify the health check that you want Amazon Route 53 to perform for each resource record set.\n\nExcept where noted, the following failover behaviors assume that you have included the `HealthCheckId` element in both resource record sets:\n\n- When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.\n- When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.\n- When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.\n- If you omit the `HealthCheckId` element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.\n\nYou can't create non-failover resource record sets that have the same values for the `Name` and `Type` elements as failover resource record sets.\n\nFor failover alias resource record sets, you must also include the `EvaluateTargetHealth` element and set the value to true.\n\nFor more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide* :\n\n- [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)\n- [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)", "stability": "external", "summary": "*Failover resource record sets only:* To configure failover, you add the `Failover` element to two resource record sets." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3727 }, "name": "failover", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation" }, "remarks": "For example, if you want all queries from Africa to be routed to a web server with an IP address of `192.0.2.111` , create a resource record set with a `Type` of `A` and a `ContinentCode` of `AF` .\n\n> Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.\n\nIf you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.\n\nYou can't create two geolocation resource record sets that specify the same geographic location.\n\nThe value `*` in the `CountryCode` element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the `Name` and `Type` elements.\n\n> Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of `CountryCode` is `*` . Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a `*` resource record set, Route 53 returns a \"no answer\" response for queries from those locations.\n\nYou can't create non-geolocation resource record sets that have the same values for the `Name` and `Type` elements as geolocation resource record sets.", "stability": "external", "summary": "*Geolocation resource record sets only:* A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3745 }, "name": "geoLocation", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroup.GeoLocationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid" }, "remarks": "Route 53 determines whether a resource record set is healthy based on one of the following:\n\n- By periodically sending a request to the endpoint that is specified in the health check\n- By aggregating the status of a specified group of health checks (calculated health checks)\n- By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)\n\n> Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the `Value` element. When you add a `HealthCheckId` element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check.\n\nFor more information, see the following topics in the *Amazon Route 53 Developer Guide* :\n\n- [How Amazon Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)\n- [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)\n- [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)\n\n*When to Specify HealthCheckId*\n\nSpecifying a value for `HealthCheckId` is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:\n\n- *Non-alias resource record sets* : You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.\n\nIf the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.\n\nIf the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.\n\nIf the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.\n- *Alias resource record sets* : You specify the following settings:\n\n- You set `EvaluateTargetHealth` to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).\n- You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.\n- You specify a health check ID for the non-alias resource record set.\n\nIf the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.\n\nIf the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.\n\n> The alias resource record set can also route traffic to a *group* of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.\n\n*Geolocation Routing*\n\nFor geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has `*` for `CountryCode` is `*` , which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:\n\n- The United States\n- North America\n- The default resource record set\n\n*Specifying the Health Check Endpoint by Domain Name*\n\nIf your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each `HTTP` server that is serving content for `www.example.com` . For the value of `FullyQualifiedDomainName` , specify the domain name of the server (such as `us-east-2-www.example.com` ), not the name of the resource record sets ( `www.example.com` ).\n\n> Health check results will be unpredictable if you do the following:\n>\n> - Create a health check that has the same value for `FullyQualifiedDomainName` as the name of a resource record set.\n> - Associate that health check with the resource record set.", "stability": "external", "summary": "If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the `HealthCheckId` element and specify the ID of the applicable health check." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3805 }, "name": "healthCheckId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid" }, "remarks": "Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .", "stability": "external", "summary": "The ID of the hosted zone that you want to create records in." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3813 }, "name": "hostedZoneId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename" }, "remarks": "You must include a trailing dot (for example, `www.example.com.` ) as part of the `HostedZoneName` .\n\nWhen you create a stack using an `AWS::Route53::RecordSet` that specifies `HostedZoneName` , AWS CloudFormation attempts to find a hosted zone whose name matches the `HostedZoneName` . If AWS CloudFormation can't find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack.\n\nSpecify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .", "stability": "external", "summary": "The name of the hosted zone that you want to create records in." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3823 }, "name": "hostedZoneName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer" }, "remarks": "Note the following:\n\n- If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.\n- If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.\n- Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.\n- If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.\n- When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.\n- If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.\n\nYou can't create multivalue answer alias records.", "stability": "external", "summary": "*Multivalue answer resource record sets only* : To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify `true` for `MultiValueAnswer` ." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3838 }, "name": "multiValueAnswer", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region" }, "remarks": "The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.\n\nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.\n\nNote the following:\n\n- You can only specify one `ResourceRecord` per latency resource record set.\n- You can only create one latency resource record set for each Amazon EC2 Region.\n- You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.\n- You can't create non-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets.", "stability": "external", "summary": "*Latency-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3875 }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords" }, "remarks": "Each record should be in the format appropriate for the record type specified by the `Type` property. For information about different record types and their record formats, see [Values That You Specify When You Create or Edit Amazon Route 53 Records](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-values.html) in the *Amazon Route 53 Developer Guide* .", "stability": "external", "summary": "Information about the records that you want to create." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3881 }, "name": "resourceRecords", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier" }, "remarks": "For information about routing policies, see [Choosing a Routing Policy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) in the *Amazon Route 53 Developer Guide* .", "stability": "external", "summary": "*Resource record sets that have a routing policy other than simple:* An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of `SetIdentifier` must be unique for each resource record set." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3889 }, "name": "setIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl" }, "remarks": "- If you're creating or updating an alias resource record set, omit `TTL` . Amazon Route 53 uses the value of `TTL` for the alias target.\n- If you're associating this resource record set with a health check (if you're adding a `HealthCheckId` element), we recommend that you specify a `TTL` of 60 seconds or less so clients respond quickly to changes in health status.\n- All of the resource record sets in a group of weighted resource record sets must have the same value for `TTL` .\n- If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a `TTL` of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for `Weight` .", "stability": "external", "summary": "The resource record cache time to live (TTL), in seconds. Note the following:." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3900 }, "name": "ttl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight" }, "remarks": "Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:\n\n- You must specify a value for the `Weight` element for every weighted resource record set.\n- You can only specify one `ResourceRecord` per weighted resource record set.\n- You can't create latency, failover, or geolocation resource record sets that have the same values for the `Name` and `Type` elements as weighted resource record sets.\n- You can create a maximum of 100 weighted resource record sets that have the same values for the `Name` and `Type` elements.\n- For weighted (but not weighted alias) resource record sets, if you set `Weight` to `0` for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set `Weight` to `0` for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.\n\nThe effect of setting `Weight` to `0` is different when you associate health checks with weighted resource record sets. For more information, see [Options for Configuring Route 53 Active-Active and Active-Passive Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html) in the *Amazon Route 53 Developer Guide* .", "stability": "external", "summary": "*Weighted resource record sets only:* Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3942 }, "name": "weight", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/route53.generated:CfnRecordSetGroup.RecordSetProperty" }, "@aws-cdk/aws-route53.CfnRecordSetGroupProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnRecordSetGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cfnRecordSetGroupProps: route53.CfnRecordSetGroupProps = {\n comment: 'comment',\n hostedZoneId: 'hostedZoneId',\n hostedZoneName: 'hostedZoneName',\n recordSets: [{\n name: 'name',\n type: 'type',\n\n // the properties below are optional\n aliasTarget: {\n dnsName: 'dnsName',\n hostedZoneId: 'hostedZoneId',\n\n // the properties below are optional\n evaluateTargetHealth: false,\n },\n cidrRoutingConfig: {\n collectionId: 'collectionId',\n locationName: 'locationName',\n },\n failover: 'failover',\n geoLocation: {\n continentCode: 'continentCode',\n countryCode: 'countryCode',\n subdivisionCode: 'subdivisionCode',\n },\n healthCheckId: 'healthCheckId',\n hostedZoneId: 'hostedZoneId',\n hostedZoneName: 'hostedZoneName',\n multiValueAnswer: false,\n region: 'region',\n resourceRecords: ['resourceRecords'],\n setIdentifier: 'setIdentifier',\n ttl: 'ttl',\n weight: 123,\n }],\n};" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSetGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3109 }, "name": "CfnRecordSetGroupProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-comment" }, "stability": "external", "summary": "*Optional:* Any comments you want to include about a change batch request." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3116 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzoneid" }, "remarks": "Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .", "stability": "external", "summary": "The ID of the hosted zone that you want to create records in." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3125 }, "name": "hostedZoneId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzonename" }, "remarks": "You must include a trailing dot (for example, `www.example.com.` ) as part of the `HostedZoneName` .\n\nWhen you create a stack using an `AWS::Route53::RecordSet` that specifies `HostedZoneName` , AWS CloudFormation attempts to find a hosted zone whose name matches the `HostedZoneName` . If AWS CloudFormation can't find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack.\n\nSpecify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .", "stability": "external", "summary": "The name of the hosted zone that you want to create records in." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3136 }, "name": "hostedZoneName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-recordsets" }, "stability": "external", "summary": "A complex type that contains one `RecordSet` element for each record that you want to create." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 3143 }, "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" } } ] } } } ], "symbolId": "lib/route53.generated:CfnRecordSetGroupProps" }, "@aws-cdk/aws-route53.CfnRecordSetProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnRecordSet`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst cfnRecordSetProps: route53.CfnRecordSetProps = {\n name: 'name',\n type: 'type',\n\n // the properties below are optional\n aliasTarget: {\n dnsName: 'dnsName',\n hostedZoneId: 'hostedZoneId',\n\n // the properties below are optional\n evaluateTargetHealth: false,\n },\n cidrRoutingConfig: {\n collectionId: 'collectionId',\n locationName: 'locationName',\n },\n comment: 'comment',\n failover: 'failover',\n geoLocation: {\n continentCode: 'continentCode',\n countryCode: 'countryCode',\n subdivisionCode: 'subdivisionCode',\n },\n healthCheckId: 'healthCheckId',\n hostedZoneId: 'hostedZoneId',\n hostedZoneName: 'hostedZoneName',\n multiValueAnswer: false,\n region: 'region',\n resourceRecords: ['resourceRecords'],\n setIdentifier: 'setIdentifier',\n ttl: 'ttl',\n weight: 123,\n};" }, "fqn": "@aws-cdk/aws-route53.CfnRecordSetProps", "kind": "interface", "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1963 }, "name": "CfnRecordSetProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name" }, "remarks": "For `ListResourceRecordSets` responses, the name of a record in the specified hosted zone.\n\n*ChangeResourceRecordSets Only*\n\nEnter a fully qualified domain name, for example, `www.example.com` . You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats `www.example.com` (without a trailing dot) and `www.example.com.` (with a trailing dot) as identical.\n\nFor information about how to specify characters other than `a-z` , `0-9` , and `-` (hyphen) and how to specify internationalized domain names, see [DNS Domain Name Format](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) in the *Amazon Route 53 Developer Guide* .\n\nYou can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, `*.example.com` . Note the following:\n\n- The * must replace the entire label. For example, you can't specify `*prod.example.com` or `prod*.example.com` .\n- The * can't replace any of the middle labels, for example, marketing.*.example.com.\n- If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.\n\n> You can't use the * wildcard for resource records sets that have a type of NS.\n\nYou can use the * wildcard as the leftmost label in a domain name, for example, `*.example.com` . You can't use an * for one of the middle labels, for example, `marketing.*.example.com` . In addition, the * must replace the entire label; for example, you can't specify `prod*.example.com` .", "stability": "external", "summary": "For `ChangeResourceRecordSets` requests, the name of the record that you want to create, update, or delete." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 1986 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type" }, "remarks": "For information about different record types and how data is encoded for them, see [Supported DNS Resource Record Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) in the *Amazon Route 53 Developer Guide* .\n\nValid values for basic resource record sets: `A` | `AAAA` | `CAA` | `CNAME` | `DS` | `MX` | `NAPTR` | `NS` | `PTR` | `SOA` | `SPF` | `SRV` | `TXT`\n\nValues for weighted, latency, geolocation, and failover resource record sets: `A` | `AAAA` | `CAA` | `CNAME` | `MX` | `NAPTR` | `PTR` | `SPF` | `SRV` | `TXT` . When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.\n\nValid values for multivalue answer resource record sets: `A` | `AAAA` | `MX` | `NAPTR` | `PTR` | `SPF` | `SRV` | `TXT`\n\n> SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of `Type` is `SPF` . RFC 7208, *Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1* , has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.\" In RFC 7208, see section 14.1, [The SPF DNS Record Type](https://docs.aws.amazon.com/http://tools.ietf.org/html/rfc7208#section-14.1) .\n\nValues for alias resource record sets:\n\n- *Amazon API Gateway custom regional APIs and edge-optimized APIs:* `A`\n- *CloudFront distributions:* `A`\n\nIf IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of `A` and one with a value of `AAAA` .\n- *Amazon API Gateway environment that has a regionalized subdomain* : `A`\n- *ELB load balancers:* `A` | `AAAA`\n- *Amazon S3 buckets:* `A`\n- *Amazon Virtual Private Cloud interface VPC endpoints* `A`\n- *Another resource record set in this hosted zone:* Specify the type of the resource record set that you're creating the alias for. All values are supported except `NS` and `SOA` .\n\n> If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of `Type` is `CNAME` . This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.", "stability": "external", "summary": "The DNS record type." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2015 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget" }, "remarks": "If you're creating resource records sets for a private hosted zone, note the following:\n\n- You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.\n- For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide* .", "stability": "external", "summary": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2027 }, "name": "aliasTarget", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSet.AliasTargetProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-cidrroutingconfig" }, "remarks": "A `LocationName` with an asterisk “*” can be used to create a default CIDR record. `CollectionId` is still required for default record.", "stability": "external", "summary": "The object that is specified in resource record set object when you are linking a resource record set to a CIDR location." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2036 }, "name": "cidrRoutingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSet.CidrRoutingConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-comment" }, "stability": "external", "summary": "*Optional:* Any comments you want to include about a change batch request." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2043 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover" }, "remarks": "For one resource record set, you specify `PRIMARY` as the value for `Failover` ; for the other resource record set, you specify `SECONDARY` . In addition, you include the `HealthCheckId` element and specify the health check that you want Amazon Route 53 to perform for each resource record set.\n\nExcept where noted, the following failover behaviors assume that you have included the `HealthCheckId` element in both resource record sets:\n\n- When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.\n- When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.\n- When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.\n- If you omit the `HealthCheckId` element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.\n\nYou can't create non-failover resource record sets that have the same values for the `Name` and `Type` elements as failover resource record sets.\n\nFor failover alias resource record sets, you must also include the `EvaluateTargetHealth` element and set the value to true.\n\nFor more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide* :\n\n- [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)\n- [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)", "stability": "external", "summary": "*Failover resource record sets only:* To configure failover, you add the `Failover` element to two resource record sets." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2066 }, "name": "failover", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation" }, "remarks": "For example, if you want all queries from Africa to be routed to a web server with an IP address of `192.0.2.111` , create a resource record set with a `Type` of `A` and a `ContinentCode` of `AF` .\n\n> Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.\n\nIf you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.\n\nYou can't create two geolocation resource record sets that specify the same geographic location.\n\nThe value `*` in the `CountryCode` element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the `Name` and `Type` elements.\n\n> Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of `CountryCode` is `*` . Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a `*` resource record set, Route 53 returns a \"no answer\" response for queries from those locations.\n\nYou can't create non-geolocation resource record sets that have the same values for the `Name` and `Type` elements as geolocation resource record sets.", "stability": "external", "summary": "*Geolocation resource record sets only:* A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2085 }, "name": "geoLocation", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-route53.CfnRecordSet.GeoLocationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid" }, "remarks": "Route 53 determines whether a resource record set is healthy based on one of the following:\n\n- By periodically sending a request to the endpoint that is specified in the health check\n- By aggregating the status of a specified group of health checks (calculated health checks)\n- By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)\n\n> Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the `Value` element. When you add a `HealthCheckId` element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check.\n\nFor more information, see the following topics in the *Amazon Route 53 Developer Guide* :\n\n- [How Amazon Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)\n- [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)\n- [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)\n\n*When to Specify HealthCheckId*\n\nSpecifying a value for `HealthCheckId` is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:\n\n- *Non-alias resource record sets* : You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.\n\nIf the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.\n\nIf the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.\n\nIf the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.\n- *Alias resource record sets* : You specify the following settings:\n\n- You set `EvaluateTargetHealth` to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).\n- You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.\n- You specify a health check ID for the non-alias resource record set.\n\nIf the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.\n\nIf the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.\n\n> The alias resource record set can also route traffic to a *group* of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.\n\n*Geolocation Routing*\n\nFor geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has `*` for `CountryCode` is `*` , which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:\n\n- The United States\n- North America\n- The default resource record set\n\n*Specifying the Health Check Endpoint by Domain Name*\n\nIf your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each `HTTP` server that is serving content for `www.example.com` . For the value of `FullyQualifiedDomainName` , specify the domain name of the server (such as `us-east-2-www.example.com` ), not the name of the resource record sets ( `www.example.com` ).\n\n> Health check results will be unpredictable if you do the following:\n>\n> - Create a health check that has the same value for `FullyQualifiedDomainName` as the name of a resource record set.\n> - Associate that health check with the resource record set.", "stability": "external", "summary": "If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the `HealthCheckId` element and specify the ID of the applicable health check." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2146 }, "name": "healthCheckId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid" }, "remarks": "Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .", "stability": "external", "summary": "The ID of the hosted zone that you want to create records in." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2155 }, "name": "hostedZoneId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename" }, "remarks": "You must include a trailing dot (for example, `www.example.com.` ) as part of the `HostedZoneName` .\n\nWhen you create a stack using an AWS::Route53::RecordSet that specifies `HostedZoneName` , AWS CloudFormation attempts to find a hosted zone whose name matches the HostedZoneName. If AWS CloudFormation cannot find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack.\n\nSpecify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .", "stability": "external", "summary": "The name of the hosted zone that you want to create records in." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2166 }, "name": "hostedZoneName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer" }, "remarks": "Note the following:\n\n- If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.\n- If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.\n- Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.\n- If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.\n- When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.\n- If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.\n\nYou can't create multivalue answer alias records.", "stability": "external", "summary": "*Multivalue answer resource record sets only* : To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify `true` for `MultiValueAnswer` ." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2182 }, "name": "multiValueAnswer", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region" }, "remarks": "The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.\n\nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.\n\nNote the following:\n\n- You can only specify one `ResourceRecord` per latency resource record set.\n- You can only create one latency resource record set for each Amazon EC2 Region.\n- You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.\n- You can't create non-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets.", "stability": "external", "summary": "*Latency-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2198 }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords" }, "remarks": "For example, if you specified `A` for `Type` , you specify one or more IP addresses in IPv4 format for `ResourceRecords` . For information about the format of values for each record type, see [Supported DNS Resource Record Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) in the *Amazon Route 53 Developer Guide* .\n\nNote the following:\n\n- You can specify more than one value for all record types except CNAME and SOA.\n- The maximum length of a value is 4000 characters.\n- If you're creating an alias record, omit `ResourceRecords` .", "stability": "external", "summary": "One or more values that correspond with the value that you specified for the `Type` property." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2211 }, "name": "resourceRecords", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier" }, "remarks": "For information about routing policies, see [Choosing a Routing Policy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) in the *Amazon Route 53 Developer Guide* .", "stability": "external", "summary": "*Resource record sets that have a routing policy other than simple:* An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of `SetIdentifier` must be unique for each resource record set." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2220 }, "name": "setIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl" }, "remarks": "- If you're creating or updating an alias resource record set, omit `TTL` . Amazon Route 53 uses the value of `TTL` for the alias target.\n- If you're associating this resource record set with a health check (if you're adding a `HealthCheckId` element), we recommend that you specify a `TTL` of 60 seconds or less so clients respond quickly to changes in health status.\n- All of the resource record sets in a group of weighted resource record sets must have the same value for `TTL` .\n- If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a `TTL` of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for `Weight` .", "stability": "external", "summary": "The resource record cache time to live (TTL), in seconds. Note the following:." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2232 }, "name": "ttl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight" }, "remarks": "Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:\n\n- You must specify a value for the `Weight` element for every weighted resource record set.\n- You can only specify one `ResourceRecord` per weighted resource record set.\n- You can't create latency, failover, or geolocation resource record sets that have the same values for the `Name` and `Type` elements as weighted resource record sets.\n- You can create a maximum of 100 weighted resource record sets that have the same values for the `Name` and `Type` elements.\n- For weighted (but not weighted alias) resource record sets, if you set `Weight` to `0` for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set `Weight` to `0` for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.\n\nThe effect of setting `Weight` to `0` is different when you associate health checks with weighted resource record sets. For more information, see [Options for Configuring Route 53 Active-Active and Active-Passive Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html) in the *Amazon Route 53 Developer Guide* .", "stability": "external", "summary": "*Weighted resource record sets only:* Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set." }, "immutable": true, "locationInModule": { "filename": "lib/route53.generated.ts", "line": 2247 }, "name": "weight", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/route53.generated:CfnRecordSetProps" }, "@aws-cdk/aws-route53.CnameRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet", "exampleMetadata": "infused" }, "stability": "stable", "summary": "A DNS CNAME record.", "example": "import * as acm from '@aws-cdk/aws-certificatemanager';\nimport * as route53 from '@aws-cdk/aws-route53';\n\nconst myDomainName = 'api.example.com';\nconst certificate = new acm.Certificate(this, 'cert', { domainName: myDomainName });\nconst api = new appsync.GraphqlApi(this, 'api', {\n name: 'myApi',\n domainName: {\n certificate,\n domainName: myDomainName,\n },\n});\n\n// hosted zone and route53 features\ndeclare const hostedZoneId: string;\ndeclare const zoneName = 'example.com';\n\n// hosted zone for adding appsync domain\nconst zone = route53.HostedZone.fromHostedZoneAttributes(this, `HostedZone`, {\n hostedZoneId,\n zoneName,\n});\n\n// create a cname to the appsync domain. will map to something like xxxx.cloudfront.net\nnew route53.CnameRecord(this, `CnameApiRecord`, {\n recordName: 'api',\n zone,\n domainName: myDomainName,\n});" }, "fqn": "@aws-cdk/aws-route53.CnameRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 312 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.CnameRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 311 }, "name": "CnameRecord", "symbolId": "lib/record-set:CnameRecord" }, "@aws-cdk/aws-route53.CnameRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a CnameRecord.", "example": "import * as acm from '@aws-cdk/aws-certificatemanager';\nimport * as route53 from '@aws-cdk/aws-route53';\n\nconst myDomainName = 'api.example.com';\nconst certificate = new acm.Certificate(this, 'cert', { domainName: myDomainName });\nconst api = new appsync.GraphqlApi(this, 'api', {\n name: 'myApi',\n domainName: {\n certificate,\n domainName: myDomainName,\n },\n});\n\n// hosted zone and route53 features\ndeclare const hostedZoneId: string;\ndeclare const zoneName = 'example.com';\n\n// hosted zone for adding appsync domain\nconst zone = route53.HostedZone.fromHostedZoneAttributes(this, `HostedZone`, {\n hostedZoneId,\n zoneName,\n});\n\n// create a cname to the appsync domain. will map to something like xxxx.cloudfront.net\nnew route53.CnameRecord(this, `CnameApiRecord`, {\n recordName: 'api',\n zone,\n domainName: myDomainName,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.CnameRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 299 }, "name": "CnameRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The domain name." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 303 }, "name": "domainName", "type": { "primitive": "string" } } ], "symbolId": "lib/record-set:CnameRecordProps" }, "@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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst commonHostedZoneProps: route53.CommonHostedZoneProps = {\n zoneName: 'zoneName',\n\n // the properties below are optional\n comment: 'comment',\n queryLogsLogGroupArn: 'queryLogsLogGroupArn',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.CommonHostedZoneProps", "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 15 }, "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": 20 }, "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": 27 }, "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": 34 }, "name": "queryLogsLogGroupArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/hosted-zone:CommonHostedZoneProps" }, "@aws-cdk/aws-route53.CrossAccountZoneDelegationRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.Construct", "docs": { "stability": "stable", "summary": "A Cross Account Zone Delegation record.", "example": "const subZone = new route53.PublicHostedZone(this, 'SubZone', {\n zoneName: 'sub.someexample.com',\n});\n\n// import the delegation role by constructing the roleArn\nconst delegationRoleArn = Stack.of(this).formatArn({\n region: '', // IAM is global in each partition\n service: 'iam',\n account: 'parent-account-id',\n resource: 'role',\n resourceName: 'MyDelegationRole',\n});\nconst delegationRole = iam.Role.fromRoleArn(this, 'DelegationRole', delegationRoleArn);\n\n// create the record\nnew route53.CrossAccountZoneDelegationRecord(this, 'delegate', {\n delegatedZone: subZone,\n parentHostedZoneName: 'someexample.com', // or you can use parentHostedZoneId\n delegationRole,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.CrossAccountZoneDelegationRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 675 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.CrossAccountZoneDelegationRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 674 }, "name": "CrossAccountZoneDelegationRecord", "symbolId": "lib/record-set:CrossAccountZoneDelegationRecord" }, "@aws-cdk/aws-route53.CrossAccountZoneDelegationRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a CrossAccountZoneDelegationRecord.", "example": "const subZone = new route53.PublicHostedZone(this, 'SubZone', {\n zoneName: 'sub.someexample.com',\n});\n\n// import the delegation role by constructing the roleArn\nconst delegationRoleArn = Stack.of(this).formatArn({\n region: '', // IAM is global in each partition\n service: 'iam',\n account: 'parent-account-id',\n resource: 'role',\n resourceName: 'MyDelegationRole',\n});\nconst delegationRole = iam.Role.fromRoleArn(this, 'DelegationRole', delegationRoleArn);\n\n// create the record\nnew route53.CrossAccountZoneDelegationRecord(this, 'delegate', {\n delegatedZone: subZone,\n parentHostedZoneName: 'someexample.com', // or you can use parentHostedZoneId\n delegationRole,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.CrossAccountZoneDelegationRecordProps", "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 631 }, "name": "CrossAccountZoneDelegationRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The zone to be delegated." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 635 }, "name": "delegatedZone", "type": { "fqn": "@aws-cdk/aws-route53.IHostedZone" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The delegation role in the parent account." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 654 }, "name": "delegationRole", "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- no zone id", "stability": "stable", "summary": "The hosted zone id in the parent account." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 649 }, "name": "parentHostedZoneId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no zone name", "stability": "stable", "summary": "The hosted zone name in the parent account." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 642 }, "name": "parentHostedZoneName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "RemovalPolicy.DESTROY", "stability": "stable", "summary": "The removal policy to apply to the record set." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 668 }, "name": "removalPolicy", "optional": true, "type": { "fqn": "@aws-cdk/core.RemovalPolicy" } }, { "abstract": true, "docs": { "default": "Duration.days(2)", "stability": "stable", "summary": "The resource record cache time to live (TTL)." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 661 }, "name": "ttl", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } } ], "symbolId": "lib/record-set:CrossAccountZoneDelegationRecordProps" }, "@aws-cdk/aws-route53.DsRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet", "exampleMetadata": "infused" }, "stability": "stable", "summary": "A DNS DS record.", "example": "declare const myZone: route53.HostedZone;\n\nnew route53.DsRecord(this, 'DSRecord', {\n zone: myZone,\n recordName: 'foo',\n values: [\n '12345 3 1 123456789abcdef67890123456789abcdef67890',\n ],\n ttl: Duration.minutes(90), // Optional - default is 30 minutes\n});" }, "fqn": "@aws-cdk/aws-route53.DsRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 592 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.DsRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 591 }, "name": "DsRecord", "symbolId": "lib/record-set:DsRecord" }, "@aws-cdk/aws-route53.DsRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a DSRecord.", "example": "declare const myZone: route53.HostedZone;\n\nnew route53.DsRecord(this, 'DSRecord', {\n zone: myZone,\n recordName: 'foo',\n values: [\n '12345 3 1 123456789abcdef67890123456789abcdef67890',\n ],\n ttl: Duration.minutes(90), // Optional - default is 30 minutes\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.DsRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 579 }, "name": "DsRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The DS values." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 583 }, "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/record-set:DsRecordProps" }, "@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).", "example": "const hostedZone = new route53.HostedZone(this, 'MyHostedZone', { zoneName: \"example.org\" });\nconst metric = new cloudwatch.Metric({\n namespace: 'AWS/Route53',\n metricName: 'DNSQueries',\n dimensionsMap: {\n HostedZoneId: hostedZone.hostedZoneId\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.HostedZone", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 152 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.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": 56 }, "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": 93 }, "name": "fromHostedZoneAttributes", "parameters": [ { "docs": { "summary": "the parent Construct for this Construct." }, "name": "scope", "type": { "fqn": "constructs.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": 70 }, "name": "fromHostedZoneId", "parameters": [ { "docs": { "summary": "the parent Construct for this Construct." }, "name": "scope", "type": { "fqn": "constructs.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": 113 }, "name": "fromLookup", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.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": 178 }, "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": 57 }, "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": 143 }, "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": 150 }, "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": 144 }, "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": 145 }, "name": "hostedZoneNameServers", "optional": true, "overrides": "@aws-cdk/aws-route53.IHostedZone", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/hosted-zone:HostedZone" }, "@aws-cdk/aws-route53.HostedZoneAttributes": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Reference to a hosted zone.", "example": "new patterns.HttpsRedirect(this, 'Redirect', {\n recordNames: ['foo.example.com'],\n targetDomain: 'bar.example.com',\n zone: route53.HostedZone.fromHostedZoneAttributes(this, 'HostedZone', {\n hostedZoneId: 'ID',\n zoneName: 'example.com',\n }),\n});", "custom": { "exampleMetadata": "infused" } }, "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" } } ], "symbolId": "lib/hosted-zone-ref:HostedZoneAttributes" }, "@aws-cdk/aws-route53.HostedZoneProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Properties of a new hosted zone.", "example": "const hostedZone = new route53.HostedZone(this, 'MyHostedZone', { zoneName: \"example.org\" });\nconst metric = new cloudwatch.Metric({\n namespace: 'AWS/Route53',\n metricName: 'DNSQueries',\n dimensionsMap: {\n HostedZoneId: hostedZone.hostedZoneId\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.HostedZoneProps", "interfaces": [ "@aws-cdk/aws-route53.CommonHostedZoneProps" ], "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 40 }, "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": 49 }, "name": "vpcs", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.IVpc" }, "kind": "array" } } } ], "symbolId": "lib/hosted-zone:HostedZoneProps" }, "@aws-cdk/aws-route53.HostedZoneProviderProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Zone properties for looking up the Hosted Zone.", "example": "import * as s3 from '@aws-cdk/aws-s3';\n\nconst recordName = 'www';\nconst domainName = 'example.com';\n\nconst bucketWebsite = new s3.Bucket(this, 'BucketWebsite', {\n bucketName: [recordName, domainName].join('.'), // www.example.com\n publicReadAccess: true,\n websiteIndexDocument: 'index.html',\n});\n\nconst zone = route53.HostedZone.fromLookup(this, 'Zone', {domainName}); // example.com\n\nnew route53.ARecord(this, 'AliasRecord', {\n zone,\n recordName, // www\n target: route53.RecordTarget.fromAlias(new targets.BucketWebsiteTarget(bucketWebsite)),\n});", "custom": { "exampleMetadata": "infused" } }, "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" } } ], "symbolId": "lib/hosted-zone-provider:HostedZoneProviderProps" }, "@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": 8 }, "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": 12 }, "name": "bind", "parameters": [ { "name": "record", "type": { "fqn": "@aws-cdk/aws-route53.IRecordSet" } }, { "name": "zone", "optional": true, "type": { "fqn": "@aws-cdk/aws-route53.IHostedZone" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-route53.AliasRecordTargetConfig" } } } ], "name": "IAliasRecordTarget", "symbolId": "lib/alias-record-target: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" } } } ], "symbolId": "lib/hosted-zone-ref:IHostedZone" }, "@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": 356 }, "name": "IPrivateHostedZone", "symbolId": "lib/hosted-zone: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": 213 }, "name": "IPublicHostedZone", "symbolId": "lib/hosted-zone: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": 19 }, "name": "IRecordSet", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The domain name of the record." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 23 }, "name": "domainName", "type": { "primitive": "string" } } ], "symbolId": "lib/record-set:IRecordSet" }, "@aws-cdk/aws-route53.MxRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet", "exampleMetadata": "fixture=_generated" }, "stability": "stable", "summary": "A DNS MX record.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const hostedZone: route53.HostedZone;\nconst mxRecord = new route53.MxRecord(this, 'MyMxRecord', {\n values: [{\n hostName: 'hostName',\n priority: 123,\n }],\n zone: hostedZone,\n\n // the properties below are optional\n comment: 'comment',\n recordName: 'recordName',\n ttl: cdk.Duration.minutes(30),\n});" }, "fqn": "@aws-cdk/aws-route53.MxRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 542 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.MxRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 541 }, "name": "MxRecord", "symbolId": "lib/record-set:MxRecord" }, "@aws-cdk/aws-route53.MxRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a MxRecord.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const hostedZone: route53.HostedZone;\nconst mxRecordProps: route53.MxRecordProps = {\n values: [{\n hostName: 'hostName',\n priority: 123,\n }],\n zone: hostedZone,\n\n // the properties below are optional\n comment: 'comment',\n recordName: 'recordName',\n ttl: cdk.Duration.minutes(30),\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.MxRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 529 }, "name": "MxRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The values." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 533 }, "name": "values", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-route53.MxRecordValue" }, "kind": "array" } } } ], "symbolId": "lib/record-set:MxRecordProps" }, "@aws-cdk/aws-route53.MxRecordValue": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a MX record value.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst mxRecordValue: route53.MxRecordValue = {\n hostName: 'hostName',\n priority: 123,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.MxRecordValue", "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 514 }, "name": "MxRecordValue", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The mail server host name." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 523 }, "name": "hostName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The priority." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 518 }, "name": "priority", "type": { "primitive": "number" } } ], "symbolId": "lib/record-set:MxRecordValue" }, "@aws-cdk/aws-route53.NsRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet", "exampleMetadata": "infused" }, "stability": "stable", "summary": "A DNS NS record.", "example": "declare const myZone: route53.HostedZone;\n\nnew route53.NsRecord(this, 'NSRecord', {\n zone: myZone,\n recordName: 'foo',\n values: [\n 'ns-1.awsdns.co.uk.',\n 'ns-2.awsdns.com.',\n ],\n ttl: Duration.minutes(90), // Optional - default is 30 minutes\n});" }, "fqn": "@aws-cdk/aws-route53.NsRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 567 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.NsRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 566 }, "name": "NsRecord", "symbolId": "lib/record-set:NsRecord" }, "@aws-cdk/aws-route53.NsRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a NSRecord.", "example": "declare const myZone: route53.HostedZone;\n\nnew route53.NsRecord(this, 'NSRecord', {\n zone: myZone,\n recordName: 'foo',\n values: [\n 'ns-1.awsdns.co.uk.',\n 'ns-2.awsdns.com.',\n ],\n ttl: Duration.minutes(90), // Optional - default is 30 minutes\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.NsRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 554 }, "name": "NsRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The NS values." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 558 }, "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/record-set:NsRecordProps" }, "@aws-cdk/aws-route53.PrivateHostedZone": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.HostedZone", "docs": { "custom": { "resource": "AWS::Route53::HostedZone", "exampleMetadata": "infused" }, "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.", "example": "declare const vpc: ec2.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});" }, "fqn": "@aws-cdk/aws-route53.PrivateHostedZone", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 386 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.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": 366 }, "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": 375 }, "name": "fromPrivateHostedZoneId", "parameters": [ { "docs": { "summary": "the parent Construct for this Construct." }, "name": "scope", "type": { "fqn": "constructs.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", "symbolId": "lib/hosted-zone: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.", "example": "declare const vpc: ec2.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});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.PrivateHostedZoneProps", "interfaces": [ "@aws-cdk/aws-route53.CommonHostedZoneProps" ], "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 343 }, "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": 350 }, "name": "vpc", "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } } ], "symbolId": "lib/hosted-zone:PrivateHostedZoneProps" }, "@aws-cdk/aws-route53.PublicHostedZone": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.HostedZone", "docs": { "custom": { "resource": "AWS::Route53::HostedZone", "exampleMetadata": "infused" }, "stability": "stable", "summary": "Create a Route53 public hosted zone.", "example": "const zoneFromAttributes = route53.PublicHostedZone.fromPublicHostedZoneAttributes(this, 'MyZone', {\n zoneName: 'example.com',\n hostedZoneId: 'ZOJJZC49E0EPZ',\n});\n\n// Does not know zoneName\nconst zoneFromId = route53.PublicHostedZone.fromPublicHostedZoneId(this, 'MyZone', 'ZOJJZC49E0EPZ');" }, "fqn": "@aws-cdk/aws-route53.PublicHostedZone", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 265 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.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": 220 }, "methods": [ { "docs": { "remarks": "Use when both hosted zone ID and hosted zone name are known.", "stability": "stable", "summary": "Imports a public hosted zone from another stack." }, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 249 }, "name": "fromPublicHostedZoneAttributes", "parameters": [ { "docs": { "summary": "the parent Construct for this Construct." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "the logical name of this Construct." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "the PublicHostedZoneAttributes (hosted zone ID and hosted zone name)." }, "name": "attrs", "type": { "fqn": "@aws-cdk/aws-route53.PublicHostedZoneAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-route53.IHostedZone" } }, "static": true }, { "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": 229 }, "name": "fromPublicHostedZoneId", "parameters": [ { "docs": { "summary": "the parent Construct for this Construct." }, "name": "scope", "type": { "fqn": "constructs.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": 310 }, "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": 300 }, "name": "addVpc", "overrides": "@aws-cdk/aws-route53.HostedZone", "parameters": [ { "name": "_vpc", "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } } ] } ], "name": "PublicHostedZone", "properties": [ { "docs": { "stability": "stable", "summary": "Role for cross account zone delegation." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 263 }, "name": "crossAccountZoneDelegationRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.Role" } } ], "symbolId": "lib/hosted-zone:PublicHostedZone" }, "@aws-cdk/aws-route53.PublicHostedZoneAttributes": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Reference to a public hosted zone.", "example": "const zoneFromAttributes = route53.PublicHostedZone.fromPublicHostedZoneAttributes(this, 'MyZone', {\n zoneName: 'example.com',\n hostedZoneId: 'ZOJJZC49E0EPZ',\n});\n\n// Does not know zoneName\nconst zoneFromId = route53.PublicHostedZone.fromPublicHostedZoneId(this, 'MyZone', 'ZOJJZC49E0EPZ');", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.PublicHostedZoneAttributes", "interfaces": [ "@aws-cdk/aws-route53.HostedZoneAttributes" ], "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone-ref.ts", "line": 55 }, "name": "PublicHostedZoneAttributes", "symbolId": "lib/hosted-zone-ref:PublicHostedZoneAttributes" }, "@aws-cdk/aws-route53.PublicHostedZoneProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a PublicHostedZone.", "example": "const parentZone = new route53.PublicHostedZone(this, 'HostedZone', {\n zoneName: 'someexample.com',\n crossAccountZoneDelegationPrincipal: new iam.AccountPrincipal('12345678901'),\n crossAccountZoneDelegationRoleName: 'MyDelegationRole',\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.PublicHostedZoneProps", "interfaces": [ "@aws-cdk/aws-route53.CommonHostedZoneProps" ], "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 186 }, "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": 193 }, "name": "caaAmazon", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- No delegation configuration", "stability": "stable", "summary": "A principal which is trusted to assume a role for zone delegation." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 200 }, "name": "crossAccountZoneDelegationPrincipal", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IPrincipal" } }, { "abstract": true, "docs": { "default": "- A role name is generated automatically", "stability": "stable", "summary": "The name of the role created for cross account delegation." }, "immutable": true, "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 207 }, "name": "crossAccountZoneDelegationRoleName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/hosted-zone:PublicHostedZoneProps" }, "@aws-cdk/aws-route53.RecordSet": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "summary": "A record set.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const hostedZone: route53.HostedZone;\ndeclare const recordTarget: route53.RecordTarget;\nconst recordSet = new route53.RecordSet(this, 'MyRecordSet', {\n recordType: route53.RecordType.A,\n target: recordTarget,\n zone: hostedZone,\n\n // the properties below are optional\n comment: 'comment',\n recordName: 'recordName',\n ttl: cdk.Duration.minutes(30),\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.RecordSet", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 219 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.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": 216 }, "name": "RecordSet", "properties": [ { "docs": { "stability": "stable", "summary": "The domain name of the record." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 217 }, "name": "domainName", "overrides": "@aws-cdk/aws-route53.IRecordSet", "type": { "primitive": "string" } } ], "symbolId": "lib/record-set:RecordSet" }, "@aws-cdk/aws-route53.RecordSetOptions": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Options for a RecordSet.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const hostedZone: route53.HostedZone;\nconst recordSetOptions: route53.RecordSetOptions = {\n zone: hostedZone,\n\n // the properties below are optional\n comment: 'comment',\n recordName: 'recordName',\n ttl: cdk.Duration.minutes(30),\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.RecordSetOptions", "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 135 }, "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": 139 }, "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": 160 }, "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": 146 }, "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": 153 }, "name": "ttl", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } } ], "symbolId": "lib/record-set:RecordSetOptions" }, "@aws-cdk/aws-route53.RecordSetProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a RecordSet.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const hostedZone: route53.HostedZone;\ndeclare const recordTarget: route53.RecordTarget;\nconst recordSetProps: route53.RecordSetProps = {\n recordType: route53.RecordType.A,\n target: recordTarget,\n zone: hostedZone,\n\n // the properties below are optional\n comment: 'comment',\n recordName: 'recordName',\n ttl: cdk.Duration.minutes(30),\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.RecordSetProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 200 }, "name": "RecordSetProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The record type." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 204 }, "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": 210 }, "name": "target", "type": { "fqn": "@aws-cdk/aws-route53.RecordTarget" } } ], "symbolId": "lib/record-set:RecordSetProps" }, "@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.", "example": "import * as cloudfront from '@aws-cdk/aws-cloudfront';\n\ndeclare const myZone: route53.HostedZone;\ndeclare const distribution: cloudfront.CloudFrontWebDistribution;\nnew route53.AaaaRecord(this, 'Alias', {\n zone: myZone,\n target: route53.RecordTarget.fromAlias(new targets.CloudFrontTarget(distribution)),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.RecordTarget", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 193 }, "parameters": [ { "docs": { "summary": "correspond with the chosen record type (e.g. for 'A' Type, specify one or 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": 166 }, "methods": [ { "docs": { "stability": "stable", "summary": "Use an alias as target." }, "locationInModule": { "filename": "lib/record-set.ts", "line": 177 }, "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": 184 }, "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": 170 }, "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": 193 }, "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 or more IP addresses)." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 193 }, "name": "values", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/record-set:RecordTarget" }, "@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": 29 }, "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#DSFormat", "stability": "stable", "summary": "A delegation signer (DS) record refers a zone key for a delegated subdomain zone." }, "name": "DS" }, { "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", "symbolId": "lib/record-set:RecordType" }, "@aws-cdk/aws-route53.SrvRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet", "exampleMetadata": "fixture=_generated" }, "stability": "stable", "summary": "A DNS SRV record.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const hostedZone: route53.HostedZone;\nconst srvRecord = new route53.SrvRecord(this, 'MySrvRecord', {\n values: [{\n hostName: 'hostName',\n port: 123,\n priority: 123,\n weight: 123,\n }],\n zone: hostedZone,\n\n // the properties below are optional\n comment: 'comment',\n recordName: 'recordName',\n ttl: cdk.Duration.minutes(30),\n});" }, "fqn": "@aws-cdk/aws-route53.SrvRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 406 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.SrvRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 405 }, "name": "SrvRecord", "symbolId": "lib/record-set:SrvRecord" }, "@aws-cdk/aws-route53.SrvRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a SrvRecord.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const hostedZone: route53.HostedZone;\nconst srvRecordProps: route53.SrvRecordProps = {\n values: [{\n hostName: 'hostName',\n port: 123,\n priority: 123,\n weight: 123,\n }],\n zone: hostedZone,\n\n // the properties below are optional\n comment: 'comment',\n recordName: 'recordName',\n ttl: cdk.Duration.minutes(30),\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.SrvRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 393 }, "name": "SrvRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The values." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 397 }, "name": "values", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-route53.SrvRecordValue" }, "kind": "array" } } } ], "symbolId": "lib/record-set:SrvRecordProps" }, "@aws-cdk/aws-route53.SrvRecordValue": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a SRV record value.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nconst srvRecordValue: route53.SrvRecordValue = {\n hostName: 'hostName',\n port: 123,\n priority: 123,\n weight: 123,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.SrvRecordValue", "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 369 }, "name": "SrvRecordValue", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The server host name." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 388 }, "name": "hostName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The port." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 383 }, "name": "port", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The priority." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 373 }, "name": "priority", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The weight." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 378 }, "name": "weight", "type": { "primitive": "number" } } ], "symbolId": "lib/record-set:SrvRecordValue" }, "@aws-cdk/aws-route53.TxtRecord": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/aws-route53.RecordSet", "docs": { "custom": { "resource": "AWS::Route53::RecordSet", "exampleMetadata": "infused" }, "stability": "stable", "summary": "A DNS TXT record.", "example": "import * as route53 from '@aws-cdk/aws-route53';\n\nconst verifyDomainIdentity = new cr.AwsCustomResource(this, 'VerifyDomainIdentity', {\n onCreate: {\n service: 'SES',\n action: 'verifyDomainIdentity',\n parameters: {\n Domain: 'example.com',\n },\n physicalResourceId: cr.PhysicalResourceId.fromResponse('VerificationToken'), // Use the token returned by the call as physical id\n },\n policy: cr.AwsCustomResourcePolicy.fromSdkCalls({\n resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE,\n }),\n});\n\ndeclare const zone: route53.HostedZone;\nnew route53.TxtRecord(this, 'SESVerificationRecord', {\n zone,\n recordName: `_amazonses.example.com`,\n values: [verifyDomainIdentity.getResponseField('VerificationToken')],\n});" }, "fqn": "@aws-cdk/aws-route53.TxtRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 337 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.TxtRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 336 }, "name": "TxtRecord", "symbolId": "lib/record-set:TxtRecord" }, "@aws-cdk/aws-route53.TxtRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a TxtRecord.", "example": "import * as route53 from '@aws-cdk/aws-route53';\n\nconst verifyDomainIdentity = new cr.AwsCustomResource(this, 'VerifyDomainIdentity', {\n onCreate: {\n service: 'SES',\n action: 'verifyDomainIdentity',\n parameters: {\n Domain: 'example.com',\n },\n physicalResourceId: cr.PhysicalResourceId.fromResponse('VerificationToken'), // Use the token returned by the call as physical id\n },\n policy: cr.AwsCustomResourcePolicy.fromSdkCalls({\n resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE,\n }),\n});\n\ndeclare const zone: route53.HostedZone;\nnew route53.TxtRecord(this, 'SESVerificationRecord', {\n zone,\n recordName: `_amazonses.example.com`,\n values: [verifyDomainIdentity.getResponseField('VerificationToken')],\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.TxtRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 324 }, "name": "TxtRecordProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The text values." }, "immutable": true, "locationInModule": { "filename": "lib/record-set.ts", "line": 328 }, "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/record-set:TxtRecordProps" }, "@aws-cdk/aws-route53.VpcEndpointServiceDomainName": { "assembly": "@aws-cdk/aws-route53", "base": "@aws-cdk/core.Construct", "docs": { "stability": "stable", "summary": "A Private DNS configuration for a VPC endpoint service.", "example": "import { HostedZone, VpcEndpointServiceDomainName } from '@aws-cdk/aws-route53';\ndeclare const zone: HostedZone;\ndeclare const vpces: ec2.VpcEndpointService;\n\nnew VpcEndpointServiceDomainName(this, 'EndpointDomain', {\n endpointService: vpces,\n domainName: 'my-stuff.aws-cdk.dev',\n publicHostedZone: zone,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.VpcEndpointServiceDomainName", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/vpc-endpoint-service-domain-name.ts", "line": 61 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.VpcEndpointServiceDomainNameProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/vpc-endpoint-service-domain-name.ts", "line": 41 }, "name": "VpcEndpointServiceDomainName", "properties": [ { "docs": { "stability": "stable", "summary": "The domain name associated with the private DNS configuration." }, "locationInModule": { "filename": "lib/vpc-endpoint-service-domain-name.ts", "line": 52 }, "name": "domainName", "type": { "primitive": "string" } } ], "symbolId": "lib/vpc-endpoint-service-domain-name:VpcEndpointServiceDomainName" }, "@aws-cdk/aws-route53.VpcEndpointServiceDomainNameProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Properties to configure a VPC Endpoint Service domain name.", "example": "import { HostedZone, VpcEndpointServiceDomainName } from '@aws-cdk/aws-route53';\ndeclare const zone: HostedZone;\ndeclare const vpces: ec2.VpcEndpointService;\n\nnew VpcEndpointServiceDomainName(this, 'EndpointDomain', {\n endpointService: vpces,\n domainName: 'my-stuff.aws-cdk.dev',\n publicHostedZone: zone,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-route53.VpcEndpointServiceDomainNameProps", "kind": "interface", "locationInModule": { "filename": "lib/vpc-endpoint-service-domain-name.ts", "line": 15 }, "name": "VpcEndpointServiceDomainNameProps", "properties": [ { "abstract": true, "docs": { "remarks": "This domain name must be owned by this account (registered through Route53),\nor delegated to this account. Domain ownership will be verified by AWS before\nprivate DNS can be used.", "see": "https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-services-dns-validation.html", "stability": "stable", "summary": "The domain name to use." }, "immutable": true, "locationInModule": { "filename": "lib/vpc-endpoint-service-domain-name.ts", "line": 30 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The VPC Endpoint Service to configure Private DNS for." }, "immutable": true, "locationInModule": { "filename": "lib/vpc-endpoint-service-domain-name.ts", "line": 20 }, "name": "endpointService", "type": { "fqn": "@aws-cdk/aws-ec2.IVpcEndpointService" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The public hosted zone to use for the domain." }, "immutable": true, "locationInModule": { "filename": "lib/vpc-endpoint-service-domain-name.ts", "line": 35 }, "name": "publicHostedZone", "type": { "fqn": "@aws-cdk/aws-route53.IPublicHostedZone" } } ], "symbolId": "lib/vpc-endpoint-service-domain-name:VpcEndpointServiceDomainNameProps" }, "@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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as cdk from '@aws-cdk/core';\nconst zoneDelegationOptions: route53.ZoneDelegationOptions = {\n comment: 'comment',\n ttl: cdk.Duration.minutes(30),\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.ZoneDelegationOptions", "kind": "interface", "locationInModule": { "filename": "lib/hosted-zone.ts", "line": 324 }, "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": 330 }, "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": 337 }, "name": "ttl", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } } ], "symbolId": "lib/hosted-zone:ZoneDelegationOptions" }, "@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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const hostedZone: route53.HostedZone;\nconst zoneDelegationRecord = new route53.ZoneDelegationRecord(this, 'MyZoneDelegationRecord', {\n nameServers: ['nameServers'],\n zone: hostedZone,\n\n // the properties below are optional\n comment: 'comment',\n recordName: 'recordName',\n ttl: cdk.Duration.minutes(30),\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.ZoneDelegationRecord", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/record-set.ts", "line": 615 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-route53.ZoneDelegationRecordProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/record-set.ts", "line": 614 }, "name": "ZoneDelegationRecord", "symbolId": "lib/record-set:ZoneDelegationRecord" }, "@aws-cdk/aws-route53.ZoneDelegationRecordProps": { "assembly": "@aws-cdk/aws-route53", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a ZoneDelegationRecord.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const hostedZone: route53.HostedZone;\nconst zoneDelegationRecordProps: route53.ZoneDelegationRecordProps = {\n nameServers: ['nameServers'],\n zone: hostedZone,\n\n // the properties below are optional\n comment: 'comment',\n recordName: 'recordName',\n ttl: cdk.Duration.minutes(30),\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-route53.ZoneDelegationRecordProps", "interfaces": [ "@aws-cdk/aws-route53.RecordSetOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/record-set.ts", "line": 604 }, "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": 608 }, "name": "nameServers", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/record-set:ZoneDelegationRecordProps" } }, "version": "1.204.0", "fingerprint": "**********" }