{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/aws-certificatemanager": "1.204.0", "@aws-cdk/aws-cloudwatch": "1.204.0", "@aws-cdk/aws-ec2": "1.204.0", "@aws-cdk/aws-iam": "1.204.0", "@aws-cdk/aws-kms": "1.204.0", "@aws-cdk/aws-logs": "1.204.0", "@aws-cdk/aws-route53": "1.204.0", "@aws-cdk/aws-secretsmanager": "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-acmpca": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.ACMPCA", "packageId": "Amazon.CDK.AWS.ACMPCA" }, "java": { "maven": { "artifactId": "acmpca", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.acmpca" }, "js": { "npm": "@aws-cdk/aws-acmpca" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-acmpca", "module": "aws_cdk.aws_acmpca" } } }, "@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-certificatemanager": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CertificateManager", "packageId": "Amazon.CDK.AWS.CertificateManager" }, "java": { "maven": { "artifactId": "certificatemanager", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.certificatemanager" }, "js": { "npm": "@aws-cdk/aws-certificatemanager" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-certificatemanager", "module": "aws_cdk.aws_certificatemanager" } } }, "@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-route53": { "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" } } }, "@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-sam": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SAM", "packageId": "Amazon.CDK.AWS.SAM" }, "java": { "maven": { "artifactId": "sam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.sam" }, "js": { "npm": "@aws-cdk/aws-sam" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-sam", "module": "aws_cdk.aws_sam" } } }, "@aws-cdk/aws-secretsmanager": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SecretsManager", "packageId": "Amazon.CDK.AWS.SecretsManager" }, "java": { "maven": { "artifactId": "secretsmanager", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.secretsmanager" }, "js": { "npm": "@aws-cdk/aws-secretsmanager" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-secretsmanager", "module": "aws_cdk.aws_secretsmanager" } } }, "@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::Elasticsearch", "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", "elasticsearch" ], "license": "Apache-2.0", "metadata": { "jsii": { "compiledWithDeprecationWarnings": true, "pacmak": { "hasDefaultInterfaces": true }, "rosetta": { "strict": true } } }, "name": "@aws-cdk/aws-elasticsearch", "readme": { "markdown": "# Amazon OpenSearch Service Construct Library\n\n\n---\n\n![Deprecated](https://img.shields.io/badge/deprecated-critical.svg?style=for-the-badge)\n\n> This API may emit warnings. Backward compatibility is not guaranteed.\n\n---\n\n\n\n> Instead of this module, we recommend using the [@aws-cdk/aws-opensearchservice](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-opensearchservice-readme.html) module. See [Amazon OpenSearch Service FAQs](https://aws.amazon.com/opensearch-service/faqs/#Name_change) for details. See [Migrating to OpenSearch](#migrating-to-opensearch) for migration instructions.\n\n## Quick start\n\nCreate a development cluster by simply specifying the version:\n\n```ts\nconst devDomain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_1,\n});\n```\n\nTo perform version upgrades without replacing the entire domain, specify the `enableVersionUpgrade` property.\n\n```ts\nconst devDomain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_10,\n enableVersionUpgrade: true, // defaults to false\n});\n```\n\nCreate a production grade cluster by also specifying things like capacity and az distribution\n\n```ts\nconst prodDomain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_1,\n capacity: {\n masterNodes: 5,\n dataNodes: 20,\n },\n ebs: {\n volumeSize: 20,\n },\n zoneAwareness: {\n availabilityZoneCount: 3,\n },\n logging: {\n slowSearchLogEnabled: true,\n appLogEnabled: true,\n slowIndexLogEnabled: true,\n },\n});\n```\n\nThis creates an Elasticsearch cluster and automatically sets up log groups for\nlogging the domain logs and slow search logs.\n\n## A note about SLR\n\nSome cluster configurations (e.g VPC access) require the existence of the [`AWSServiceRoleForAmazonElasticsearchService`](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/slr.html) service-linked role.\n\nWhen performing such operations via the AWS Console, this SLR is created automatically when needed. However, this is not the behavior when using CloudFormation. If an SLR is needed, but doesn't exist, you will encounter a failure message simlar to:\n\n```console\nBefore you can proceed, you must enable a service-linked role to give Amazon ES...\n```\n\nTo resolve this, you need to [create](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#create-service-linked-role) the SLR. We recommend using the AWS CLI:\n\n```console\naws iam create-service-linked-role --aws-service-name es.amazonaws.com\n```\n\nYou can also create it using the CDK, **but note that only the first application deploying this will succeed**:\n\n```ts\nconst slr = new iam.CfnServiceLinkedRole(this, 'ElasticSLR', {\n awsServiceName: 'es.amazonaws.com',\n});\n```\n\n## Importing existing domains\n\nTo import an existing domain into your CDK application, use the `Domain.fromDomainEndpoint` factory method.\nThis method accepts a domain endpoint of an already existing domain:\n\n```ts\nconst domainEndpoint = 'https://my-domain-jcjotrt6f7otem4sqcwbch3c4u.us-east-1.es.amazonaws.com';\nconst domain = es.Domain.fromDomainEndpoint(this, 'ImportedDomain', domainEndpoint);\n```\n\n## Permissions\n\n### IAM\n\nHelper methods also exist for managing access to the domain.\n\n```ts\ndeclare const fn: lambda.Function;\ndeclare const domain: es.Domain;\n\n// Grant write access to the app-search index\ndomain.grantIndexWrite('app-search', fn);\n\n// Grant read access to the 'app-search/_search' path\ndomain.grantPathRead('app-search/_search', fn);\n```\n\n## Encryption\n\nThe domain can also be created with encryption enabled:\n\n```ts\nconst domain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_4,\n ebs: {\n volumeSize: 100,\n volumeType: ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD,\n },\n nodeToNodeEncryption: true,\n encryptionAtRest: {\n enabled: true,\n },\n});\n```\n\nThis sets up the domain with node to node encryption and encryption at\nrest. You can also choose to supply your own KMS key to use for encryption at\nrest.\n\n## VPC Support\n\nElasticsearch domains can be placed inside a VPC, providing a secure communication between Amazon ES and other services within the VPC without the need for an internet gateway, NAT device, or VPN connection.\n\n> See [Launching your Amazon OpenSearch Service domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) for more details.\n\n```ts\nconst vpc = new ec2.Vpc(this, 'Vpc');\nconst domainProps: es.DomainProps = {\n version: es.ElasticsearchVersion.V7_1,\n removalPolicy: RemovalPolicy.DESTROY,\n vpc,\n // must be enabled since our VPC contains multiple private subnets.\n zoneAwareness: {\n enabled: true,\n },\n capacity: {\n // must be an even number since the default az count is 2.\n dataNodes: 2,\n },\n};\nnew es.Domain(this, 'Domain', domainProps);\n```\n\nIn addition, you can use the `vpcSubnets` property to control which specific subnets will be used, and the `securityGroups` property to control\nwhich security groups will be attached to the domain. By default, CDK will select all *private* subnets in the VPC, and create one dedicated security group.\n\n## Metrics\n\nHelper methods exist to access common domain metrics for example:\n\n```ts\ndeclare const domain: es.Domain;\nconst freeStorageSpace = domain.metricFreeStorageSpace();\nconst masterSysMemoryUtilization = domain.metric('MasterSysMemoryUtilization');\n```\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n## Fine grained access control\n\nThe domain can also be created with a master user configured. The password can\nbe supplied or dynamically created if not supplied.\n\n```ts\nconst domain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_1,\n enforceHttps: true,\n nodeToNodeEncryption: true,\n encryptionAtRest: {\n enabled: true,\n },\n fineGrainedAccessControl: {\n masterUserName: 'master-user',\n },\n});\n\nconst masterUserPassword = domain.masterUserPassword;\n```\n\n## Using unsigned basic auth\n\nFor convenience, the domain can be configured to allow unsigned HTTP requests\nthat use basic auth. Unless the domain is configured to be part of a VPC this\nmeans anyone can access the domain using the configured master username and\npassword.\n\nTo enable unsigned basic auth access the domain is configured with an access\npolicy that allows anyonmous requests, HTTPS required, node to node encryption,\nencryption at rest and fine grained access control.\n\nIf the above settings are not set they will be configured as part of enabling\nunsigned basic auth. If they are set with conflicting values, an error will be\nthrown.\n\nIf no master user is configured a default master user is created with the\nusername `admin`.\n\nIf no password is configured a default master user password is created and\nstored in the AWS Secrets Manager as secret. The secret has the prefix\n`MasterUser`.\n\n```ts\nconst domain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_1,\n useUnsignedBasicAuth: true,\n});\n\nconst masterUserPassword = domain.masterUserPassword;\n```\n\n## Custom access policies\n\nIf the domain requires custom access control it can be configured either as a\nconstructor property, or later by means of a helper method.\n\nFor simple permissions the `accessPolicies` constructor may be sufficient:\n\n```ts\nconst domain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_1,\n accessPolicies: [\n new iam.PolicyStatement({\n actions: ['es:*ESHttpPost', 'es:ESHttpPut*'],\n effect: iam.Effect.ALLOW,\n principals: [new iam.AccountPrincipal('123456789012')],\n resources: ['*'],\n }),\n ]\n});\n```\n\nFor more complex use-cases, for example, to set the domain up to receive data from a\n[cross-account Kinesis Firehose](https://aws.amazon.com/premiumsupport/knowledge-center/kinesis-firehose-cross-account-streaming/) the `addAccessPolicies` helper method\nallows for policies that include the explicit domain ARN.\n\n```ts\nconst domain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_1,\n});\n\ndomain.addAccessPolicies(\n new iam.PolicyStatement({\n actions: ['es:ESHttpPost', 'es:ESHttpPut'],\n effect: iam.Effect.ALLOW,\n principals: [new iam.AccountPrincipal('123456789012')],\n resources: [domain.domainArn, `${domain.domainArn}/*`],\n }),\n new iam.PolicyStatement({\n actions: ['es:ESHttpGet'],\n effect: iam.Effect.ALLOW,\n principals: [new iam.AccountPrincipal('123456789012')],\n resources: [\n `${domain.domainArn}/_all/_settings`,\n `${domain.domainArn}/_cluster/stats`,\n `${domain.domainArn}/index-name*/_mapping/type-name`,\n `${domain.domainArn}/roletest*/_mapping/roletest`,\n `${domain.domainArn}/_nodes`,\n `${domain.domainArn}/_nodes/stats`,\n `${domain.domainArn}/_nodes/*/stats`,\n `${domain.domainArn}/_stats`,\n `${domain.domainArn}/index-name*/_stats`,\n `${domain.domainArn}/roletest*/_stat`,\n ],\n }),\n);\n```\n\n## Audit logs\n\nAudit logs can be enabled for a domain, but only when fine-grained access control is enabled.\n\n```ts\nconst domain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_1,\n enforceHttps: true,\n nodeToNodeEncryption: true,\n encryptionAtRest: {\n enabled: true,\n },\n fineGrainedAccessControl: {\n masterUserName: 'master-user',\n },\n logging: {\n auditLogEnabled: true,\n slowSearchLogEnabled: true,\n appLogEnabled: true,\n slowIndexLogEnabled: true,\n },\n});\n```\n\n## UltraWarm\n\nUltraWarm nodes can be enabled to provide a cost-effective way to store large amounts of read-only data.\n\n```ts\nconst domain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_10,\n capacity: {\n masterNodes: 2,\n warmNodes: 2,\n warmInstanceType: 'ultrawarm1.medium.elasticsearch',\n },\n});\n```\n\n## Custom endpoint\n\nCustom endpoints can be configured to reach the ES domain under a custom domain name.\n\n```ts\nnew es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_7,\n customEndpoint: {\n domainName: 'search.example.com',\n },\n});\n```\n\nIt is also possible to specify a custom certificate instead of the auto-generated one.\n\nAdditionally, an automatic CNAME-Record is created if a hosted zone is provided for the custom endpoint\n\n## Advanced options\n\n[Advanced cluster settings](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) can used to configure additional options.\n\n```ts\nnew es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_7,\n advancedOptions: {\n 'rest.action.multi.allow_explicit_index': 'false',\n 'indices.fielddata.cache.size': '25',\n 'indices.query.bool.max_clause_count': '2048',\n },\n});\n```\n\n## Migrating to OpenSearch\n\nTo migrate from this module (`@aws-cdk/aws-elasticsearch`) to the new `@aws-cdk/aws-opensearchservice` module, you must modify your CDK application to refer to the new module (including some associated changes) and then perform a CloudFormation resource deletion/import.\n\n### Necessary CDK Modifications\n\nMake the following modifications to your CDK application to migrate to the `@aws-cdk/aws-opensearchservice` module.\n\n- Rewrite module imports to use `'@aws-cdk/aws-opensearchservice` to `'@aws-cdk/aws-elasticsearch`.\n For example:\n\n ```ts nofixture\n import * as es from '@aws-cdk/aws-elasticsearch';\n import { Domain } from '@aws-cdk/aws-elasticsearch';\n ```\n\n ...becomes...\n\n ```ts nofixture\n import * as opensearch from '@aws-cdk/aws-opensearchservice';\n import { Domain } from '@aws-cdk/aws-opensearchservice';\n ```\n\n- Replace instances of `es.ElasticsearchVersion` with `opensearch.EngineVersion`.\n For example:\n\n ```ts fixture=migrate-opensearch\n const version = es.ElasticsearchVersion.V7_1;\n ```\n\n ...becomes...\n\n ```ts fixture=migrate-opensearch\n const version = opensearch.EngineVersion.ELASTICSEARCH_7_1;\n ```\n\n- Replace the `cognitoKibanaAuth` property of `DomainProps` with `cognitoDashboardsAuth`.\n For example:\n\n ```ts fixture=migrate-opensearch\n new es.Domain(this, 'Domain', {\n cognitoKibanaAuth: {\n identityPoolId: 'test-identity-pool-id',\n userPoolId: 'test-user-pool-id',\n role: role,\n },\n version: elasticsearchVersion,\n });\n ```\n\n ...becomes...\n\n ```ts fixture=migrate-opensearch\n new opensearch.Domain(this, 'Domain', {\n cognitoDashboardsAuth: {\n identityPoolId: 'test-identity-pool-id',\n userPoolId: 'test-user-pool-id',\n role: role,\n },\n version: openSearchVersion,\n });\n ```\n\n- Rewrite instance type suffixes from `.elasticsearch` to `.search`.\n For example:\n\n ```ts fixture=migrate-opensearch\n new es.Domain(this, 'Domain', {\n capacity: {\n masterNodeInstanceType: 'r5.large.elasticsearch',\n },\n version: elasticsearchVersion,\n });\n ```\n\n ...becomes...\n\n ```ts fixture=migrate-opensearch\n new opensearch.Domain(this, 'Domain', {\n capacity: {\n masterNodeInstanceType: 'r5.large.search',\n },\n version: openSearchVersion,\n });\n ```\n\n- Any `CfnInclude`'d domains will need to be re-written in their original template in\n order to be successfully included as a `opensearch.CfnDomain`\n\n### CloudFormation Migration\n\nFollow these steps to migrate your application without data loss:\n\n- Ensure that the [removal policy](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.RemovalPolicy.html) on your domains are set to `RemovalPolicy.RETAIN`. This is the default for the domain construct, so nothing is required unless you have specifically set the removal policy to some other value.\n- Remove the domain resource from your CloudFormation stacks by manually modifying the synthesized templates used to create the CloudFormation stacks. This may also involve modifying or deleting dependent resources, such as the custom resources that CDK creates to manage the domain's access policy or any other resource you have connected to the domain. You will need to search for references to each domain's logical ID to determine which other resources refer to it and replace or delete those references. Do not remove resources that are dependencies of the domain or you will have to recreate or import them before importing the domain. After modification, deploy the stacks through the AWS Management Console or using the AWS CLI.\n- Migrate your CDK application to use the new `@aws-cdk/aws-opensearchservice` module by applying the necessary modifications listed above. Synthesize your application and obtain the resulting stack templates.\n- Copy just the definition of the domain from the \"migrated\" templates to the corresponding \"stripped\" templates that you deployed above. [Import](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-existing-stack.html) the orphaned domains into your CloudFormation stacks using these templates.\n- Synthesize and deploy your CDK application to reconfigure/recreate the modified dependent resources. The CloudFormation stacks should now contain the same resources as existed prior to migration.\n- Proceed with development as normal!\n" }, "repository": { "directory": "packages/@aws-cdk/aws-elasticsearch", "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.Elasticsearch", "packageId": "Amazon.CDK.AWS.Elasticsearch" }, "java": { "maven": { "artifactId": "elasticsearch", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.elasticsearch" }, "js": { "npm": "@aws-cdk/aws-elasticsearch" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-elasticsearch", "module": "aws_cdk.aws_elasticsearch" } }, "types": { "@aws-cdk/aws-elasticsearch.AdvancedSecurityOptions": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Specifies options for fine-grained access control.", "example": "const domain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_1,\n enforceHttps: true,\n nodeToNodeEncryption: true,\n encryptionAtRest: {\n enabled: true,\n },\n fineGrainedAccessControl: {\n masterUserName: 'master-user',\n },\n});\n\nconst masterUserPassword = domain.masterUserPassword;", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-elasticsearch.AdvancedSecurityOptions", "kind": "interface", "locationInModule": { "filename": "lib/domain.ts", "line": 430 }, "name": "AdvancedSecurityOptions", "properties": [ { "abstract": true, "docs": { "default": "- fine-grained access control is disabled", "deprecated": "use opensearchservice module instead", "remarks": "Only specify this or masterUserName, but not both.", "stability": "deprecated", "summary": "ARN for the master user." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 437 }, "name": "masterUserArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- fine-grained access control is disabled", "deprecated": "use opensearchservice module instead", "remarks": "Only specify this or masterUserArn, but not both.", "stability": "deprecated", "summary": "Username for the master user." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 445 }, "name": "masterUserName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- A Secrets Manager generated password", "deprecated": "use opensearchservice module instead", "remarks": "You can use `SecretValue.unsafePlainText` to specify a password in plain text or\nuse `secretsmanager.Secret.fromSecretAttributes` to reference a secret in\nSecrets Manager.", "stability": "deprecated", "summary": "Password for the master user." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 457 }, "name": "masterUserPassword", "optional": true, "type": { "fqn": "@aws-cdk/core.SecretValue" } } ], "symbolId": "lib/domain:AdvancedSecurityOptions" }, "@aws-cdk/aws-elasticsearch.CapacityConfig": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Configures the capacity of the cluster such as the instance type and the number of instances.", "example": "const domain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_10,\n capacity: {\n masterNodes: 2,\n warmNodes: 2,\n warmInstanceType: 'ultrawarm1.medium.elasticsearch',\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-elasticsearch.CapacityConfig", "kind": "interface", "locationInModule": { "filename": "lib/domain.ts", "line": 137 }, "name": "CapacityConfig", "properties": [ { "abstract": true, "docs": { "default": "- r5.large.elasticsearch", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The instance type for your data nodes, such as `m3.medium.elasticsearch`. For valid values, see [Supported Instance Types](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-supported-instance-types.html) in the Amazon Elasticsearch Service Developer Guide." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 175 }, "name": "dataNodeInstanceType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- 1", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The number of data nodes (instances) to use in the Amazon ES domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 164 }, "name": "dataNodes", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- r5.large.elasticsearch", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The hardware configuration of the computer that hosts the dedicated master node, such as `m3.medium.elasticsearch`. For valid values, see [Supported Instance Types] (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-supported-instance-types.html) in the Amazon Elasticsearch Service Developer Guide." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 156 }, "name": "masterNodeInstanceType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no dedicated master nodes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The number of instances to use for the master node." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 144 }, "name": "masterNodes", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- ultrawarm1.medium.elasticsearch", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The instance type for your UltraWarm node, such as `ultrawarm1.medium.elasticsearch`. For valid values, see [UltraWarm Storage Limits] (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-limits.html#limits-ultrawarm) in the Amazon Elasticsearch Service Developer Guide." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 194 }, "name": "warmInstanceType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no UltraWarm nodes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The number of UltraWarm nodes (instances) to use in the Amazon ES domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 183 }, "name": "warmNodes", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/domain:CapacityConfig" }, "@aws-cdk/aws-elasticsearch.CfnDomain": { "assembly": "@aws-cdk/aws-elasticsearch", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Elasticsearch::Domain", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.\n\n> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see [Remarks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks) .", "stability": "external", "summary": "A CloudFormation `AWS::Elasticsearch::Domain`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\n\ndeclare const accessPolicies: any;\nconst cfnDomain = new elasticsearch.CfnDomain(this, 'MyCfnDomain', /* all optional props */ {\n accessPolicies: accessPolicies,\n advancedOptions: {\n advancedOptionsKey: 'advancedOptions',\n },\n advancedSecurityOptions: {\n anonymousAuthEnabled: false,\n enabled: false,\n internalUserDatabaseEnabled: false,\n masterUserOptions: {\n masterUserArn: 'masterUserArn',\n masterUserName: 'masterUserName',\n masterUserPassword: 'masterUserPassword',\n },\n },\n cognitoOptions: {\n enabled: false,\n identityPoolId: 'identityPoolId',\n roleArn: 'roleArn',\n userPoolId: 'userPoolId',\n },\n domainEndpointOptions: {\n customEndpoint: 'customEndpoint',\n customEndpointCertificateArn: 'customEndpointCertificateArn',\n customEndpointEnabled: false,\n enforceHttps: false,\n tlsSecurityPolicy: 'tlsSecurityPolicy',\n },\n domainName: 'domainName',\n ebsOptions: {\n ebsEnabled: false,\n iops: 123,\n volumeSize: 123,\n volumeType: 'volumeType',\n },\n elasticsearchClusterConfig: {\n coldStorageOptions: {\n enabled: false,\n },\n dedicatedMasterCount: 123,\n dedicatedMasterEnabled: false,\n dedicatedMasterType: 'dedicatedMasterType',\n instanceCount: 123,\n instanceType: 'instanceType',\n warmCount: 123,\n warmEnabled: false,\n warmType: 'warmType',\n zoneAwarenessConfig: {\n availabilityZoneCount: 123,\n },\n zoneAwarenessEnabled: false,\n },\n elasticsearchVersion: 'elasticsearchVersion',\n encryptionAtRestOptions: {\n enabled: false,\n kmsKeyId: 'kmsKeyId',\n },\n logPublishingOptions: {\n logPublishingOptionsKey: {\n cloudWatchLogsLogGroupArn: 'cloudWatchLogsLogGroupArn',\n enabled: false,\n },\n },\n nodeToNodeEncryptionOptions: {\n enabled: false,\n },\n snapshotOptions: {\n automatedSnapshotStartHour: 123,\n },\n tags: [{\n key: 'key',\n value: 'value',\n }],\n vpcOptions: {\n securityGroupIds: ['securityGroupIds'],\n subnetIds: ['subnetIds'],\n },\n});" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Elasticsearch::Domain`." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 383 }, "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-elasticsearch.CfnDomainProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 230 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 416 }, "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/elasticsearch.generated.ts", "line": 441 }, "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": "CfnDomain", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 234 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "remarks": "This returned value is the same as the one returned by `AWS::Elasticsearch::Domain.DomainArn` .", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the domain, such as `arn:aws:es:us-west-2:123456789012:domain/mystack-elasti-1ab2cdefghij` ." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 259 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DomainEndpoint" }, "stability": "external", "summary": "The domain-specific endpoint that's used for requests to the OpenSearch APIs, such as `search-mystack-elasti-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com` ." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 265 }, "name": "attrDomainEndpoint", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 421 }, "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-elasticsearch-domain.html#cfn-elasticsearch-domain-tags" }, "stability": "external", "summary": "An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 367 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-accesspolicies" }, "remarks": "For more information, see [Configuring access policies](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ac.html#ac-creating) in the *Amazon OpenSearch Service Developer Guid* e.", "stability": "external", "summary": "An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 272 }, "name": "accessPolicies", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedoptions" }, "remarks": "For more information, see [Advanced cluster parameters](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "Additional options to specify for the OpenSearch Service domain." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 279 }, "name": "advancedOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedsecurityoptions" }, "stability": "external", "summary": "Specifies options for fine-grained access control." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 286 }, "name": "advancedSecurityOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.AdvancedSecurityOptionsInputProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-cognitooptions" }, "stability": "external", "summary": "Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 293 }, "name": "cognitoOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.CognitoOptionsProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainendpointoptions" }, "stability": "external", "summary": "Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 300 }, "name": "domainEndpointOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.DomainEndpointOptionsProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainname" }, "remarks": "For valid values, see the [DomainName](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-domainname) data type in the *Amazon OpenSearch Service Developer Guide* . If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .\n\n> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", "stability": "external", "summary": "A name for the OpenSearch Service domain." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 309 }, "name": "domainName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-ebsoptions" }, "remarks": "For more information, see [EBS volume size limits](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 316 }, "name": "ebsOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.EBSOptionsProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchclusterconfig" }, "stability": "external", "summary": "ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 323 }, "name": "elasticsearchClusterConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.ElasticsearchClusterConfigProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchversion" }, "remarks": "If you set the [EnableVersionUpgrade](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain) update policy to `true` , you can update `ElasticsearchVersion` without interruption. When `EnableVersionUpgrade` is set to `false` , or is not specified, updating `ElasticsearchVersion` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .", "stability": "external", "summary": "The version of Elasticsearch to use, such as 2.3. If not specified, 1.5 is used as the default. For information about the versions that OpenSearch Service supports, see [Supported versions of OpenSearch and Elasticsearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide* ." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 332 }, "name": "elasticsearchVersion", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-encryptionatrestoptions" }, "remarks": "See [Encryption of data at rest for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/encryption-at-rest.html) .", "stability": "external", "summary": "Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 339 }, "name": "encryptionAtRestOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.EncryptionAtRestOptionsProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-logpublishingoptions" }, "remarks": "Each key needs a valid `LogPublishingOption` value.", "stability": "external", "summary": "An object with one or more of the following keys: `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , `AUDIT_LOGS` , depending on the types of logs you want to publish." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 346 }, "name": "logPublishingOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.LogPublishingOptionProperty" } ] } }, "kind": "map" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-nodetonodeencryptionoptions" }, "remarks": "See [Node-to-node encryption for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ntn.html) .", "stability": "external", "summary": "Specifies whether node-to-node encryption is enabled." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 353 }, "name": "nodeToNodeEncryptionOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.NodeToNodeEncryptionOptionsProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-snapshotoptions" }, "remarks": "The automated snapshot configuration for the OpenSearch Service domain indices.", "stability": "external", "summary": "*DEPRECATED* ." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 360 }, "name": "snapshotOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.SnapshotOptionsProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-vpcoptions" }, "remarks": "For more information, see [Launching your Amazon OpenSearch Service domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "The virtual private cloud (VPC) configuration for the OpenSearch Service domain." }, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 374 }, "name": "vpcOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.VPCOptionsProperty" } ] } } } ], "symbolId": "lib/elasticsearch.generated:CfnDomain" }, "@aws-cdk/aws-elasticsearch.CfnDomain.AdvancedSecurityOptionsInputProperty": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "Specifies options for fine-grained access control.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\nconst advancedSecurityOptionsInputProperty: elasticsearch.CfnDomain.AdvancedSecurityOptionsInputProperty = {\n anonymousAuthEnabled: false,\n enabled: false,\n internalUserDatabaseEnabled: false,\n masterUserOptions: {\n masterUserArn: 'masterUserArn',\n masterUserName: 'masterUserName',\n masterUserPassword: 'masterUserPassword',\n },\n};" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.AdvancedSecurityOptionsInputProperty", "kind": "interface", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 457 }, "name": "AdvancedSecurityOptionsInputProperty", "namespace": "CfnDomain", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html#cfn-elasticsearch-domain-advancedsecurityoptionsinput-anonymousauthenabled" }, "stability": "external", "summary": "`CfnDomain.AdvancedSecurityOptionsInputProperty.AnonymousAuthEnabled`." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 463 }, "name": "anonymousAuthEnabled", "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-elasticsearch-domain-advancedsecurityoptionsinput.html#cfn-elasticsearch-domain-advancedsecurityoptionsinput-enabled" }, "remarks": "You must also enable encryption of data at rest and node-to-node encryption.", "stability": "external", "summary": "True to enable fine-grained access control." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 469 }, "name": "enabled", "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-elasticsearch-domain-advancedsecurityoptionsinput.html#cfn-elasticsearch-domain-advancedsecurityoptionsinput-internaluserdatabaseenabled" }, "stability": "external", "summary": "True to enable the internal user database." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 475 }, "name": "internalUserDatabaseEnabled", "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-elasticsearch-domain-advancedsecurityoptionsinput.html#cfn-elasticsearch-domain-advancedsecurityoptionsinput-masteruseroptions" }, "stability": "external", "summary": "Specifies information about the master user." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 481 }, "name": "masterUserOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.MasterUserOptionsProperty" } ] } } } ], "symbolId": "lib/elasticsearch.generated:CfnDomain.AdvancedSecurityOptionsInputProperty" }, "@aws-cdk/aws-elasticsearch.CfnDomain.CognitoOptionsProperty": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\nconst cognitoOptionsProperty: elasticsearch.CfnDomain.CognitoOptionsProperty = {\n enabled: false,\n identityPoolId: 'identityPoolId',\n roleArn: 'roleArn',\n userPoolId: 'userPoolId',\n};" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.CognitoOptionsProperty", "kind": "interface", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 553 }, "name": "CognitoOptionsProperty", "namespace": "CfnDomain", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-enabled" }, "remarks": "See [Amazon Cognito authentication for OpenSearch Dashboards](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html) .", "stability": "external", "summary": "Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 559 }, "name": "enabled", "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-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-identitypoolid" }, "remarks": "Required if you enable Cognito authentication.", "stability": "external", "summary": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 565 }, "name": "identityPoolId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-rolearn" }, "remarks": "Required if you enable Cognito authentication.", "stability": "external", "summary": "The `AmazonESCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 571 }, "name": "roleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-userpoolid" }, "remarks": "Required if you enable Cognito authentication.", "stability": "external", "summary": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 577 }, "name": "userPoolId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/elasticsearch.generated:CfnDomain.CognitoOptionsProperty" }, "@aws-cdk/aws-elasticsearch.CfnDomain.ColdStorageOptionsProperty": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-coldstorageoptions.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "Specifies options for cold storage. For more information, see [Cold storage for Amazon Elasticsearch Service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/cold-storage.html) .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\nconst coldStorageOptionsProperty: elasticsearch.CfnDomain.ColdStorageOptionsProperty = {\n enabled: false,\n};" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.ColdStorageOptionsProperty", "kind": "interface", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 649 }, "name": "ColdStorageOptionsProperty", "namespace": "CfnDomain", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-coldstorageoptions.html#cfn-elasticsearch-domain-coldstorageoptions-enabled" }, "remarks": "You must enable UltraWarm storage in order to enable cold storage.", "stability": "external", "summary": "Whether to enable or disable cold storage on the domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 655 }, "name": "enabled", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/elasticsearch.generated:CfnDomain.ColdStorageOptionsProperty" }, "@aws-cdk/aws-elasticsearch.CfnDomain.DomainEndpointOptionsProperty": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\nconst domainEndpointOptionsProperty: elasticsearch.CfnDomain.DomainEndpointOptionsProperty = {\n customEndpoint: 'customEndpoint',\n customEndpointCertificateArn: 'customEndpointCertificateArn',\n customEndpointEnabled: false,\n enforceHttps: false,\n tlsSecurityPolicy: 'tlsSecurityPolicy',\n};" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.DomainEndpointOptionsProperty", "kind": "interface", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 718 }, "name": "DomainEndpointOptionsProperty", "namespace": "CfnDomain", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpoint" }, "remarks": "Required if you enabled a custom endpoint for the domain.", "stability": "external", "summary": "The fully qualified URL for your custom endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 724 }, "name": "customEndpoint", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpointcertificatearn" }, "remarks": "Required if you enabled a custom endpoint for the domain.", "stability": "external", "summary": "The AWS Certificate Manager ARN for your domain's SSL/TLS certificate." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 730 }, "name": "customEndpointCertificateArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpointenabled" }, "remarks": "If enabled, you must also provide values for `CustomEndpoint` and `CustomEndpointCertificateArn` .", "stability": "external", "summary": "True to enable a custom endpoint for the domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 736 }, "name": "customEndpointEnabled", "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-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-enforcehttps" }, "stability": "external", "summary": "True to require that all traffic to the domain arrive over HTTPS." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 742 }, "name": "enforceHttps", "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-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-tlssecuritypolicy" }, "remarks": "- `Policy-Min-TLS-1-0-2019-07`\n- `Policy-Min-TLS-1-2-2019-07`", "stability": "external", "summary": "The minimum TLS version required for traffic to the domain. Valid values are TLS 1.0 (default) or 1.2:." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 751 }, "name": "tlsSecurityPolicy", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/elasticsearch.generated:CfnDomain.DomainEndpointOptionsProperty" }, "@aws-cdk/aws-elasticsearch.CfnDomain.EBSOptionsProperty": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For more information, see [EBS volume size limits](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the *Amazon OpenSearch Service Developer Guide* .\n\n> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\nconst eBSOptionsProperty: elasticsearch.CfnDomain.EBSOptionsProperty = {\n ebsEnabled: false,\n iops: 123,\n volumeSize: 123,\n volumeType: 'volumeType',\n};" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.EBSOptionsProperty", "kind": "interface", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 826 }, "name": "EBSOptionsProperty", "namespace": "CfnDomain", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-ebsenabled" }, "stability": "external", "summary": "Specifies whether Amazon EBS volumes are attached to data nodes in the OpenSearch Service domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 832 }, "name": "ebsEnabled", "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-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-iops" }, "remarks": "This property applies only to provisioned IOPS EBS volume types.", "stability": "external", "summary": "The number of I/O operations per second (IOPS) that the volume supports." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 838 }, "name": "iops", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumesize" }, "remarks": "The minimum and maximum size of an EBS volume depends on the EBS volume type and the instance type to which it is attached. For more information, see [EBS volume size limits](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "The size (in GiB) of the EBS volume for each data node." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 844 }, "name": "volumeSize", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumetype" }, "remarks": "For more information about each type, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide for Linux Instances* .", "stability": "external", "summary": "The EBS volume type to use with the OpenSearch Service domain, such as standard, gp2, or io1." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 850 }, "name": "volumeType", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/elasticsearch.generated:CfnDomain.EBSOptionsProperty" }, "@aws-cdk/aws-elasticsearch.CfnDomain.ElasticsearchClusterConfigProperty": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html", "exampleMetadata": "fixture=_generated" }, "remarks": "You can specify options such as the instance type and the number of instances. For more information, see [Creating and managing Amazon OpenSearch Service domains](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html) in the *Amazon OpenSearch Service Developer Guide* .\n\n> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "The cluster configuration for the OpenSearch Service domain.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\nconst elasticsearchClusterConfigProperty: elasticsearch.CfnDomain.ElasticsearchClusterConfigProperty = {\n coldStorageOptions: {\n enabled: false,\n },\n dedicatedMasterCount: 123,\n dedicatedMasterEnabled: false,\n dedicatedMasterType: 'dedicatedMasterType',\n instanceCount: 123,\n instanceType: 'instanceType',\n warmCount: 123,\n warmEnabled: false,\n warmType: 'warmType',\n zoneAwarenessConfig: {\n availabilityZoneCount: 123,\n },\n zoneAwarenessEnabled: false,\n};" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.ElasticsearchClusterConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 922 }, "name": "ElasticsearchClusterConfigProperty", "namespace": "CfnDomain", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-coldstorageoptions" }, "stability": "external", "summary": "Specifies cold storage options for the domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 928 }, "name": "coldStorageOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.ColdStorageOptionsProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmastercount" }, "remarks": "If you specify this property, you must specify true for the DedicatedMasterEnabled property.", "stability": "external", "summary": "The number of instances to use for the master node." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 934 }, "name": "dedicatedMasterCount", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmasterenabled" }, "remarks": "A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. See [Dedicated master nodes in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-dedicatedmasternodes.html) .", "stability": "external", "summary": "Indicates whether to use a dedicated master node for the OpenSearch Service domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 940 }, "name": "dedicatedMasterEnabled", "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-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmastertype" }, "stability": "external", "summary": "The hardware configuration of the computer that hosts the dedicated master node, such as `m3.medium.elasticsearch` . If you specify this property, you must specify true for the `DedicatedMasterEnabled` property. For valid values, see [Supported instance types in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) ." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 946 }, "name": "dedicatedMasterType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-instancecount" }, "stability": "external", "summary": "The number of data nodes (instances) to use in the OpenSearch Service domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 952 }, "name": "instanceCount", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-instnacetype" }, "stability": "external", "summary": "The instance type for your data nodes, such as `m3.medium.elasticsearch` . For valid values, see [Supported instance types in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) ." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 958 }, "name": "instanceType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-warmcount" }, "remarks": "Required if you enable warm storage.", "stability": "external", "summary": "The number of warm nodes in the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 964 }, "name": "warmCount", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-warmenabled" }, "stability": "external", "summary": "Whether to enable warm storage for the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 970 }, "name": "warmEnabled", "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-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-warmtype" }, "remarks": "Required if you enable warm storage.", "stability": "external", "summary": "The instance type for the cluster's warm nodes." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 976 }, "name": "warmType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-zoneawarenessconfig" }, "remarks": "Only use if `ZoneAwarenessEnabled` is `true` .", "stability": "external", "summary": "Specifies zone awareness configuration options." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 982 }, "name": "zoneAwarenessConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.ZoneAwarenessConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-zoneawarenessenabled" }, "remarks": "When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see [Configuring a multi-AZ domain in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html) .", "stability": "external", "summary": "Indicates whether to enable zone awareness for the OpenSearch Service domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 988 }, "name": "zoneAwarenessEnabled", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/elasticsearch.generated:CfnDomain.ElasticsearchClusterConfigProperty" }, "@aws-cdk/aws-elasticsearch.CfnDomain.EncryptionAtRestOptionsProperty": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\nconst encryptionAtRestOptionsProperty: elasticsearch.CfnDomain.EncryptionAtRestOptionsProperty = {\n enabled: false,\n kmsKeyId: 'kmsKeyId',\n};" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.EncryptionAtRestOptionsProperty", "kind": "interface", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1081 }, "name": "EncryptionAtRestOptionsProperty", "namespace": "CfnDomain", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-enabled" }, "stability": "external", "summary": "Specify `true` to enable encryption at rest." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1087 }, "name": "enabled", "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-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-kmskeyid" }, "remarks": "Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a` . Required if you enable encryption at rest.", "stability": "external", "summary": "The KMS key ID." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1093 }, "name": "kmsKeyId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/elasticsearch.generated:CfnDomain.EncryptionAtRestOptionsProperty" }, "@aws-cdk/aws-elasticsearch.CfnDomain.LogPublishingOptionProperty": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Specifies whether the OpenSearch Service domain publishes the Elasticsearch application, search slow logs, or index slow logs to Amazon CloudWatch. Each option must be an object of name `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , or `AUDIT_LOGS` depending on the type of logs you want to publish.\n\nIf you enable a slow log, you still have to enable the *collection* of slow logs using the Configuration API. To learn more, see [Enabling log publishing ( AWS CLI)](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html#createdomain-configure-slow-logs-cli) .", "stability": "external", "summary": "> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\nconst logPublishingOptionProperty: elasticsearch.CfnDomain.LogPublishingOptionProperty = {\n cloudWatchLogsLogGroupArn: 'cloudWatchLogsLogGroupArn',\n enabled: false,\n};" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.LogPublishingOptionProperty", "kind": "interface", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1161 }, "name": "LogPublishingOptionProperty", "namespace": "CfnDomain", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html#cfn-elasticsearch-domain-logpublishingoption-cloudwatchlogsloggrouparn" }, "remarks": "Required if you enable log publishing for the domain.", "stability": "external", "summary": "Specifies the CloudWatch log group to publish to." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1167 }, "name": "cloudWatchLogsLogGroupArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html#cfn-elasticsearch-domain-logpublishingoption-enabled" }, "remarks": "Default: `false` .", "stability": "external", "summary": "If `true` , enables the publishing of logs to CloudWatch." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1175 }, "name": "enabled", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/elasticsearch.generated:CfnDomain.LogPublishingOptionProperty" }, "@aws-cdk/aws-elasticsearch.CfnDomain.MasterUserOptionsProperty": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "Specifies information about the master user. Required if you enabled the internal user database.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\nconst masterUserOptionsProperty: elasticsearch.CfnDomain.MasterUserOptionsProperty = {\n masterUserArn: 'masterUserArn',\n masterUserName: 'masterUserName',\n masterUserPassword: 'masterUserPassword',\n};" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.MasterUserOptionsProperty", "kind": "interface", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1241 }, "name": "MasterUserOptionsProperty", "namespace": "CfnDomain", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html#cfn-elasticsearch-domain-masteruseroptions-masteruserarn" }, "remarks": "Only specify if `InternalUserDatabaseEnabled` is false in `AdvancedSecurityOptions` .", "stability": "external", "summary": "ARN for the master user." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1247 }, "name": "masterUserArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html#cfn-elasticsearch-domain-masteruseroptions-masterusername" }, "remarks": "Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions` .", "stability": "external", "summary": "Username for the master user." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1253 }, "name": "masterUserName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html#cfn-elasticsearch-domain-masteruseroptions-masteruserpassword" }, "remarks": "Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions` .", "stability": "external", "summary": "Password for the master user." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1259 }, "name": "masterUserPassword", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/elasticsearch.generated:CfnDomain.MasterUserOptionsProperty" }, "@aws-cdk/aws-elasticsearch.CfnDomain.NodeToNodeEncryptionOptionsProperty": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-nodetonodeencryptionoptions.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "Specifies whether node-to-node encryption is enabled.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\nconst nodeToNodeEncryptionOptionsProperty: elasticsearch.CfnDomain.NodeToNodeEncryptionOptionsProperty = {\n enabled: false,\n};" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.NodeToNodeEncryptionOptionsProperty", "kind": "interface", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1328 }, "name": "NodeToNodeEncryptionOptionsProperty", "namespace": "CfnDomain", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-nodetonodeencryptionoptions.html#cfn-elasticsearch-domain-nodetonodeencryptionoptions-enabled" }, "stability": "external", "summary": "Specifies whether node-to-node encryption is enabled, as a Boolean." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1334 }, "name": "enabled", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/elasticsearch.generated:CfnDomain.NodeToNodeEncryptionOptionsProperty" }, "@aws-cdk/aws-elasticsearch.CfnDomain.SnapshotOptionsProperty": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html", "exampleMetadata": "fixture=_generated" }, "remarks": "*DEPRECATED* . For domains running Elasticsearch 5.3 and later, OpenSearch Service takes hourly automated snapshots, making this setting irrelevant. For domains running earlier versions of Elasticsearch, OpenSearch Service takes daily automated snapshots.\n\nThe automated snapshot configuration for the OpenSearch Service domain indices.", "stability": "external", "summary": "> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\nconst snapshotOptionsProperty: elasticsearch.CfnDomain.SnapshotOptionsProperty = {\n automatedSnapshotStartHour: 123,\n};" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.SnapshotOptionsProperty", "kind": "interface", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1399 }, "name": "SnapshotOptionsProperty", "namespace": "CfnDomain", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html#cfn-elasticsearch-domain-snapshotoptions-automatedsnapshotstarthour" }, "remarks": "For example, if you specify 0, OpenSearch Service takes an automated snapshot everyday between midnight and 1 am. You can specify a value between 0 and 23.", "stability": "external", "summary": "The hour in UTC during which the service takes an automated daily snapshot of the indices in the OpenSearch Service domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1405 }, "name": "automatedSnapshotStartHour", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/elasticsearch.generated:CfnDomain.SnapshotOptionsProperty" }, "@aws-cdk/aws-elasticsearch.CfnDomain.VPCOptionsProperty": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For more information, see [Launching your Amazon OpenSearch Service domains using a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer Guide* .\n\n> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "The virtual private cloud (VPC) configuration for the OpenSearch Service domain.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\nconst vPCOptionsProperty: elasticsearch.CfnDomain.VPCOptionsProperty = {\n securityGroupIds: ['securityGroupIds'],\n subnetIds: ['subnetIds'],\n};" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.VPCOptionsProperty", "kind": "interface", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1468 }, "name": "VPCOptionsProperty", "namespace": "CfnDomain", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-securitygroupids" }, "remarks": "If you don't provide a security group ID, OpenSearch Service uses the default security group for the VPC. To learn more, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon VPC User Guide* .", "stability": "external", "summary": "The list of security group IDs that are associated with the VPC endpoints for the domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1474 }, "name": "securityGroupIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-subnetids" }, "remarks": "For example, you must specify three subnet IDs for a three Availability Zone domain. To learn more, see [VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) in the *Amazon VPC User Guide* .\n\nRequired if you're creating your domain inside a VPC.", "stability": "external", "summary": "Provide one subnet ID for each Availability Zone that your domain uses." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1482 }, "name": "subnetIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/elasticsearch.generated:CfnDomain.VPCOptionsProperty" }, "@aws-cdk/aws-elasticsearch.CfnDomain.ZoneAwarenessConfigProperty": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "Specifies zone awareness configuration options. Only use if `ZoneAwarenessEnabled` is `true` .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\nconst zoneAwarenessConfigProperty: elasticsearch.CfnDomain.ZoneAwarenessConfigProperty = {\n availabilityZoneCount: 123,\n};" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.ZoneAwarenessConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1548 }, "name": "ZoneAwarenessConfigProperty", "namespace": "CfnDomain", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html#cfn-elasticsearch-domain-zoneawarenessconfig-availabilityzonecount" }, "remarks": "Valid values are `2` and `3` . Default is 2.", "stability": "external", "summary": "If you enabled multiple Availability Zones (AZs), the number of AZs that you want the domain to use." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 1556 }, "name": "availabilityZoneCount", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/elasticsearch.generated:CfnDomain.ZoneAwarenessConfigProperty" }, "@aws-cdk/aws-elasticsearch.CfnDomainProps": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDomain`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\n\ndeclare const accessPolicies: any;\nconst cfnDomainProps: elasticsearch.CfnDomainProps = {\n accessPolicies: accessPolicies,\n advancedOptions: {\n advancedOptionsKey: 'advancedOptions',\n },\n advancedSecurityOptions: {\n anonymousAuthEnabled: false,\n enabled: false,\n internalUserDatabaseEnabled: false,\n masterUserOptions: {\n masterUserArn: 'masterUserArn',\n masterUserName: 'masterUserName',\n masterUserPassword: 'masterUserPassword',\n },\n },\n cognitoOptions: {\n enabled: false,\n identityPoolId: 'identityPoolId',\n roleArn: 'roleArn',\n userPoolId: 'userPoolId',\n },\n domainEndpointOptions: {\n customEndpoint: 'customEndpoint',\n customEndpointCertificateArn: 'customEndpointCertificateArn',\n customEndpointEnabled: false,\n enforceHttps: false,\n tlsSecurityPolicy: 'tlsSecurityPolicy',\n },\n domainName: 'domainName',\n ebsOptions: {\n ebsEnabled: false,\n iops: 123,\n volumeSize: 123,\n volumeType: 'volumeType',\n },\n elasticsearchClusterConfig: {\n coldStorageOptions: {\n enabled: false,\n },\n dedicatedMasterCount: 123,\n dedicatedMasterEnabled: false,\n dedicatedMasterType: 'dedicatedMasterType',\n instanceCount: 123,\n instanceType: 'instanceType',\n warmCount: 123,\n warmEnabled: false,\n warmType: 'warmType',\n zoneAwarenessConfig: {\n availabilityZoneCount: 123,\n },\n zoneAwarenessEnabled: false,\n },\n elasticsearchVersion: 'elasticsearchVersion',\n encryptionAtRestOptions: {\n enabled: false,\n kmsKeyId: 'kmsKeyId',\n },\n logPublishingOptions: {\n logPublishingOptionsKey: {\n cloudWatchLogsLogGroupArn: 'cloudWatchLogsLogGroupArn',\n enabled: false,\n },\n },\n nodeToNodeEncryptionOptions: {\n enabled: false,\n },\n snapshotOptions: {\n automatedSnapshotStartHour: 123,\n },\n tags: [{\n key: 'key',\n value: 'value',\n }],\n vpcOptions: {\n securityGroupIds: ['securityGroupIds'],\n subnetIds: ['subnetIds'],\n },\n};" }, "fqn": "@aws-cdk/aws-elasticsearch.CfnDomainProps", "kind": "interface", "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 19 }, "name": "CfnDomainProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-accesspolicies" }, "remarks": "For more information, see [Configuring access policies](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ac.html#ac-creating) in the *Amazon OpenSearch Service Developer Guid* e.", "stability": "external", "summary": "An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 26 }, "name": "accessPolicies", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedoptions" }, "remarks": "For more information, see [Advanced cluster parameters](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "Additional options to specify for the OpenSearch Service domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 33 }, "name": "advancedOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedsecurityoptions" }, "stability": "external", "summary": "Specifies options for fine-grained access control." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 40 }, "name": "advancedSecurityOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.AdvancedSecurityOptionsInputProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-cognitooptions" }, "stability": "external", "summary": "Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 47 }, "name": "cognitoOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.CognitoOptionsProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainendpointoptions" }, "stability": "external", "summary": "Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 54 }, "name": "domainEndpointOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.DomainEndpointOptionsProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainname" }, "remarks": "For valid values, see the [DomainName](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-domainname) data type in the *Amazon OpenSearch Service Developer Guide* . If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .\n\n> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", "stability": "external", "summary": "A name for the OpenSearch Service domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 63 }, "name": "domainName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-ebsoptions" }, "remarks": "For more information, see [EBS volume size limits](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 70 }, "name": "ebsOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.EBSOptionsProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchclusterconfig" }, "stability": "external", "summary": "ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 77 }, "name": "elasticsearchClusterConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.ElasticsearchClusterConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchversion" }, "remarks": "If you set the [EnableVersionUpgrade](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain) update policy to `true` , you can update `ElasticsearchVersion` without interruption. When `EnableVersionUpgrade` is set to `false` , or is not specified, updating `ElasticsearchVersion` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .", "stability": "external", "summary": "The version of Elasticsearch to use, such as 2.3. If not specified, 1.5 is used as the default. For information about the versions that OpenSearch Service supports, see [Supported versions of OpenSearch and Elasticsearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide* ." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 86 }, "name": "elasticsearchVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-encryptionatrestoptions" }, "remarks": "See [Encryption of data at rest for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/encryption-at-rest.html) .", "stability": "external", "summary": "Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 93 }, "name": "encryptionAtRestOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.EncryptionAtRestOptionsProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-logpublishingoptions" }, "remarks": "Each key needs a valid `LogPublishingOption` value.", "stability": "external", "summary": "An object with one or more of the following keys: `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , `AUDIT_LOGS` , depending on the types of logs you want to publish." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 100 }, "name": "logPublishingOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.LogPublishingOptionProperty" } ] } }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-nodetonodeencryptionoptions" }, "remarks": "See [Node-to-node encryption for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ntn.html) .", "stability": "external", "summary": "Specifies whether node-to-node encryption is enabled." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 107 }, "name": "nodeToNodeEncryptionOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.NodeToNodeEncryptionOptionsProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-snapshotoptions" }, "remarks": "The automated snapshot configuration for the OpenSearch Service domain indices.", "stability": "external", "summary": "*DEPRECATED* ." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 114 }, "name": "snapshotOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.SnapshotOptionsProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-tags" }, "stability": "external", "summary": "An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 121 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-vpcoptions" }, "remarks": "For more information, see [Launching your Amazon OpenSearch Service domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer Guide* .", "stability": "external", "summary": "The virtual private cloud (VPC) configuration for the OpenSearch Service domain." }, "immutable": true, "locationInModule": { "filename": "lib/elasticsearch.generated.ts", "line": 128 }, "name": "vpcOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-elasticsearch.CfnDomain.VPCOptionsProperty" } ] } } } ], "symbolId": "lib/elasticsearch.generated:CfnDomainProps" }, "@aws-cdk/aws-elasticsearch.CognitoOptions": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "deprecated": "use opensearchservice module instead", "see": "https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html", "stability": "deprecated", "summary": "Configures Amazon ES to use Amazon Cognito authentication for Kibana.", "example": "new es.Domain(this, 'Domain', {\n cognitoKibanaAuth: {\n identityPoolId: 'test-identity-pool-id',\n userPoolId: 'test-user-pool-id',\n role: role,\n },\n version: elasticsearchVersion,\n});", "custom": { "exampleMetadata": "fixture=migrate-opensearch infused" } }, "fqn": "@aws-cdk/aws-elasticsearch.CognitoOptions", "kind": "interface", "locationInModule": { "filename": "lib/domain.ts", "line": 389 }, "name": "CognitoOptions", "properties": [ { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The Amazon Cognito identity pool ID that you want Amazon ES to use for Kibana authentication." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 395 }, "name": "identityPoolId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "remarks": "It must have the `AmazonESCognitoAccess` policy attached to it.", "see": "https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html#es-cognito-auth-prereq", "stability": "deprecated", "summary": "A role that allows Amazon ES to configure your user pool and identity pool." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 403 }, "name": "role", "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The Amazon Cognito user pool ID that you want Amazon ES to use for Kibana authentication." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 410 }, "name": "userPoolId", "type": { "primitive": "string" } } ], "symbolId": "lib/domain:CognitoOptions" }, "@aws-cdk/aws-elasticsearch.CustomEndpointOptions": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Configures a custom domain endpoint for the ES domain.", "example": "new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_7,\n customEndpoint: {\n domainName: 'search.example.com',\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-elasticsearch.CustomEndpointOptions", "kind": "interface", "locationInModule": { "filename": "lib/domain.ts", "line": 465 }, "name": "CustomEndpointOptions", "properties": [ { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The custom domain name to assign." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 471 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- create a new one", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The certificate to use." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 478 }, "name": "certificate", "optional": true, "type": { "fqn": "@aws-cdk/aws-certificatemanager.ICertificate" } }, { "abstract": true, "docs": { "default": "- do not create a CNAME", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The hosted zone in Route53 to create the CNAME record in." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 485 }, "name": "hostedZone", "optional": true, "type": { "fqn": "@aws-cdk/aws-route53.IHostedZone" } } ], "symbolId": "lib/domain:CustomEndpointOptions" }, "@aws-cdk/aws-elasticsearch.Domain": { "assembly": "@aws-cdk/aws-elasticsearch", "base": "@aws-cdk/core.Resource", "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Provides an Elasticsearch domain.", "example": "const domain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_4,\n ebs: {\n volumeSize: 100,\n volumeType: ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD,\n },\n nodeToNodeEncryption: true,\n encryptionAtRest: {\n enabled: true,\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-elasticsearch.Domain", "initializer": { "docs": { "stability": "deprecated" }, "locationInModule": { "filename": "lib/domain.ts", "line": 1470 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-elasticsearch.DomainProps" } } ] }, "interfaces": [ "@aws-cdk/aws-elasticsearch.IDomain", "@aws-cdk/aws-ec2.IConnectable" ], "kind": "class", "locationInModule": { "filename": "lib/domain.ts", "line": 1358 }, "methods": [ { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Creates a Domain construct that represents an external domain." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1394 }, "name": "fromDomainAttributes", "parameters": [ { "docs": { "summary": "The parent creating construct (usually `this`)." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "The construct's name." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "A `DomainAttributes` object." }, "name": "attrs", "type": { "fqn": "@aws-cdk/aws-elasticsearch.DomainAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-elasticsearch.IDomain" } }, "static": true }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Creates a Domain construct that represents an external domain via domain endpoint." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1367 }, "name": "fromDomainEndpoint", "parameters": [ { "docs": { "summary": "The parent creating construct (usually `this`)." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "The construct's name." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "The domain's endpoint." }, "name": "domainEndpoint", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-elasticsearch.IDomain" } }, "static": true }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Add policy statements to the domain access policy." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1951 }, "name": "addAccessPolicies", "parameters": [ { "name": "accessPolicyStatements", "type": { "fqn": "@aws-cdk/aws-iam.PolicyStatement" }, "variadic": true } ], "variadic": true }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant read permissions for an index in this domain to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1011 }, "name": "grantIndexRead", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "docs": { "summary": "The index to grant permissions for." }, "name": "index", "type": { "primitive": "string" } }, { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1045 }, "name": "grantIndexReadWrite", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "docs": { "summary": "The index to grant permissions for." }, "name": "index", "type": { "primitive": "string" } }, { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant write permissions for an index in this domain to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1028 }, "name": "grantIndexWrite", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "docs": { "summary": "The index to grant permissions for." }, "name": "index", "type": { "primitive": "string" } }, { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1062 }, "name": "grantPathRead", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "docs": { "summary": "The path to grant permissions for." }, "name": "path", "type": { "primitive": "string" } }, { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1094 }, "name": "grantPathReadWrite", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "docs": { "summary": "The path to grant permissions for." }, "name": "path", "type": { "primitive": "string" } }, { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1078 }, "name": "grantPathWrite", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "docs": { "summary": "The path to grant permissions for." }, "name": "path", "type": { "primitive": "string" } }, { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 962 }, "name": "grantRead", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 994 }, "name": "grantReadWrite", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 978 }, "name": "grantWrite", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Return the given named metric for this Domain." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1107 }, "name": "metric", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "metricName", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for automated snapshot failures." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1192 }, "name": "metricAutomatedSnapshotFailure", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "maximum over 1 minute", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for the cluster blocking index writes." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1164 }, "name": "metricClusterIndexWritesBlocked", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for the time the cluster status is red." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1125 }, "name": "metricClusterStatusRed", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for the time the cluster status is yellow." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1138 }, "name": "metricClusterStatusYellow", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for CPU utilization." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1205 }, "name": "metricCPUUtilization", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "minimum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for the storage space of nodes in the cluster." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1151 }, "name": "metricFreeStorageSpace", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "p99 over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for indexing latency." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1306 }, "name": "metricIndexingLatency", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for JVM memory pressure." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1218 }, "name": "metricJVMMemoryPressure", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for KMS key errors." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1257 }, "name": "metricKMSKeyError", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for KMS key being inaccessible." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1270 }, "name": "metricKMSKeyInaccessible", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for master CPU utilization." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1231 }, "name": "metricMasterCPUUtilization", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for master JVM memory pressure." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1244 }, "name": "metricMasterJVMMemoryPressure", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "minimum over 1 hour", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for the number of nodes." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1178 }, "name": "metricNodes", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for number of searchable documents." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1283 }, "name": "metricSearchableDocuments", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "p99 over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for search latency." }, "locationInModule": { "filename": "lib/domain.ts", "line": 1296 }, "name": "metricSearchLatency", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } } ], "name": "Domain", "properties": [ { "docs": { "deprecated": "use opensearchservice module instead", "remarks": "This will throw an error in case the domain\nis not placed inside a VPC.", "stability": "deprecated", "summary": "Manages network connections to the domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 1939 }, "name": "connections", "overrides": "@aws-cdk/aws-ec2.IConnectable", "type": { "fqn": "@aws-cdk/aws-ec2.Connections" } }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Arn of the Elasticsearch domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 1411 }, "name": "domainArn", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "type": { "primitive": "string" } }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Endpoint of the Elasticsearch domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 1421 }, "name": "domainEndpoint", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "type": { "primitive": "string" } }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Domain name of the Elasticsearch domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 1416 }, "name": "domainName", "overrides": "@aws-cdk/aws-elasticsearch.IDomain", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Log group that application logs are logged to." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 1445 }, "name": "appLogGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } }, { "docs": { "custom": { "attribute": "true" }, "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Log group that audit logs are logged to." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 1453 }, "name": "auditLogGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } }, { "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Master user password if fine grained access control is configured." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 1460 }, "name": "masterUserPassword", "optional": true, "type": { "fqn": "@aws-cdk/core.SecretValue" } }, { "docs": { "custom": { "attribute": "true" }, "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Log group that slow indices are logged to." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 1437 }, "name": "slowIndexLogGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } }, { "docs": { "custom": { "attribute": "true" }, "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Log group that slow searches are logged to." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 1429 }, "name": "slowSearchLogGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } } ], "symbolId": "lib/domain:Domain" }, "@aws-cdk/aws-elasticsearch.DomainAttributes": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Reference to an Elasticsearch domain.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as elasticsearch from '@aws-cdk/aws-elasticsearch';\nconst domainAttributes: elasticsearch.DomainAttributes = {\n domainArn: 'domainArn',\n domainEndpoint: 'domainEndpoint',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-elasticsearch.DomainAttributes", "kind": "interface", "locationInModule": { "filename": "lib/domain.ts", "line": 1336 }, "name": "DomainAttributes", "properties": [ { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The ARN of the Elasticsearch domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 1342 }, "name": "domainArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The domain endpoint of the Elasticsearch domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 1349 }, "name": "domainEndpoint", "type": { "primitive": "string" } } ], "symbolId": "lib/domain:DomainAttributes" }, "@aws-cdk/aws-elasticsearch.DomainProps": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Properties for an AWS Elasticsearch Domain.", "example": "const domain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_4,\n ebs: {\n volumeSize: 100,\n volumeType: ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD,\n },\n nodeToNodeEncryption: true,\n encryptionAtRest: {\n enabled: true,\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-elasticsearch.DomainProps", "kind": "interface", "locationInModule": { "filename": "lib/domain.ts", "line": 493 }, "name": "DomainProps", "properties": [ { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The Elasticsearch version that your domain will leverage." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 560 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "abstract": true, "docs": { "default": "- No access policies.", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Domain Access policies." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 500 }, "name": "accessPolicies", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-iam.PolicyStatement" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- no advanced options are specified", "deprecated": "use opensearchservice module instead", "see": "https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options", "stability": "deprecated", "summary": "Additional options to specify for the Amazon ES domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 509 }, "name": "advancedOptions", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- Hourly automated snapshots not used", "deprecated": "use opensearchservice module instead", "remarks": "Only applies for Elasticsearch\nversions below 5.3.", "stability": "deprecated", "summary": "The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon ES domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 595 }, "name": "automatedSnapshotStartHour", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- 1 r5.large.elasticsearch data node; no dedicated master nodes.", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The cluster capacity configuration for the Amazon ES domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 545 }, "name": "capacity", "optional": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.CapacityConfig" } }, { "abstract": true, "docs": { "default": "- Cognito not used for authentication to Kibana.", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Configures Amazon ES to use Amazon Cognito authentication for Kibana." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 517 }, "name": "cognitoKibanaAuth", "optional": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.CognitoOptions" } }, { "abstract": true, "docs": { "default": "- no custom domain endpoint will be configured", "deprecated": "use opensearchservice module instead", "remarks": "If you specify a Route53 hosted zone it will create a CNAME record and use DNS validation for the certificate", "stability": "deprecated", "summary": "To configure a custom domain configure these options." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 698 }, "name": "customEndpoint", "optional": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.CustomEndpointOptions" } }, { "abstract": true, "docs": { "default": "- A name will be auto-generated.", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Enforces a particular physical domain name." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 525 }, "name": "domainName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- 10 GiB General Purpose (SSD) volumes per node.", "deprecated": "use opensearchservice module instead", "remarks": "For more information, see\n[Configuring EBS-based Storage]\n(https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs)\nin the Amazon Elasticsearch Service Developer Guide.", "stability": "deprecated", "summary": "The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon ES domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 537 }, "name": "ebs", "optional": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.EbsOptions" } }, { "abstract": true, "docs": { "default": "- false", "deprecated": "use opensearchservice module instead", "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeelasticsearchdomain", "stability": "deprecated", "summary": "To upgrade an Amazon ES domain to a new version of Elasticsearch rather than replacing the entire domain resource, use the EnableVersionUpgrade update policy." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 681 }, "name": "enableVersionUpgrade", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- No encryption at rest", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Encryption at rest options for the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 568 }, "name": "encryptionAtRest", "optional": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.EncryptionAtRestOptions" } }, { "abstract": true, "docs": { "default": "- false", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "True to require that all traffic to the domain arrive over HTTPS." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 637 }, "name": "enforceHttps", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- fine-grained access control is disabled", "deprecated": "use opensearchservice module instead", "remarks": "Requires Elasticsearch version 6.7 or later. Enabling fine-grained access control\nalso requires encryption of data at rest and node-to-node encryption, along with\nenforced HTTPS.", "stability": "deprecated", "summary": "Specifies options for fine-grained access control." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 656 }, "name": "fineGrainedAccessControl", "optional": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.AdvancedSecurityOptions" } }, { "abstract": true, "docs": { "default": "- No logs are published", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Configuration log publishing configuration options." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 576 }, "name": "logging", "optional": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.LoggingOptions" } }, { "abstract": true, "docs": { "default": "- Node to node encryption is not enabled.", "deprecated": "use opensearchservice module instead", "remarks": "Requires Elasticsearch version 6.0 or later.", "stability": "deprecated", "summary": "Specify true to enable node to node encryption." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 585 }, "name": "nodeToNodeEncryption", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "RemovalPolicy.RETAIN", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Policy to apply when the domain is removed from the stack." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 689 }, "name": "removalPolicy", "optional": true, "type": { "fqn": "@aws-cdk/core.RemovalPolicy" } }, { "abstract": true, "docs": { "default": "- One new security group is created.", "deprecated": "use opensearchservice module instead", "remarks": "Only used if `vpc` is specified.", "see": "https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html", "stability": "deprecated", "summary": "The list of security groups that are associated with the VPC endpoints for the domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 616 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- TLSSecurityPolicy.TLS_1_0", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The minimum TLS version required for traffic to the domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 645 }, "name": "tlsSecurityPolicy", "optional": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.TLSSecurityPolicy" } }, { "abstract": true, "docs": { "default": "- false", "deprecated": "use opensearchservice module instead", "remarks": "If no master user is provided a default master user\nwith username `admin` and a dynamically generated password stored in KMS is created. The password can be retrieved\nby getting `masterUserPassword` from the domain instance.\n\nSetting this to true will also add an access policy that allows unsigned\naccess, enable node to node encryption, encryption at rest. If conflicting\nsettings are encountered (like disabling encryption at rest) enabling this\nsetting will cause a failure.", "stability": "deprecated", "summary": "Configures the domain so that unsigned basic auth is enabled." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 671 }, "name": "useUnsignedBasicAuth", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Domain is not placed in a VPC.", "deprecated": "use opensearchservice module instead", "see": "https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html", "stability": "deprecated", "summary": "Place the domain inside this VPC." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 604 }, "name": "vpc", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } }, { "abstract": true, "docs": { "default": "- All private subnets.", "deprecated": "use opensearchservice module instead", "remarks": "You must provide one subnet for each Availability Zone\nthat your domain uses. For example, you must specify three subnet IDs for a three Availability Zone\ndomain.\n\nOnly used if `vpc` is specified.", "see": "https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html", "stability": "deprecated", "summary": "The specific vpc subnets the domain will be placed in." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 629 }, "name": "vpcSubnets", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- no zone awareness (1 AZ)", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The cluster zone awareness configuration for the Amazon ES domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 553 }, "name": "zoneAwareness", "optional": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ZoneAwarenessConfig" } } ], "symbolId": "lib/domain:DomainProps" }, "@aws-cdk/aws-elasticsearch.EbsOptions": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "deprecated": "use opensearchservice module instead", "remarks": "For more information, see\n[Configuring EBS-based Storage]\n(https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs)\nin the Amazon Elasticsearch Service Developer Guide.", "stability": "deprecated", "summary": "The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon ES domain.", "example": "const prodDomain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_1,\n capacity: {\n masterNodes: 5,\n dataNodes: 20,\n },\n ebs: {\n volumeSize: 20,\n },\n zoneAwareness: {\n availabilityZoneCount: 3,\n },\n logging: {\n slowSearchLogEnabled: true,\n appLogEnabled: true,\n slowIndexLogEnabled: true,\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-elasticsearch.EbsOptions", "kind": "interface", "locationInModule": { "filename": "lib/domain.ts", "line": 239 }, "name": "EbsOptions", "properties": [ { "abstract": true, "docs": { "default": "- true", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon ES domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 247 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- iops are not set.", "deprecated": "use opensearchservice module instead", "remarks": "This property applies only to the Provisioned IOPS (SSD) EBS\nvolume type.", "stability": "deprecated", "summary": "The number of I/O operations per second (IOPS) that the volume supports." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 257 }, "name": "iops", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "10", "deprecated": "use opensearchservice module instead", "remarks": "The minimum and\nmaximum size of an EBS volume depends on the EBS volume type and the\ninstance type to which it is attached. For more information, see\n[Configuring EBS-based Storage]\n(https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs)\nin the Amazon Elasticsearch Service Developer Guide.", "stability": "deprecated", "summary": "The size (in GiB) of the EBS volume for each data node." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 270 }, "name": "volumeSize", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "gp2", "deprecated": "use opensearchservice module instead", "remarks": "For more information, see[Configuring EBS-based Storage]\n(https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs)\nin the Amazon Elasticsearch Service Developer Guide.", "stability": "deprecated", "summary": "The EBS volume type to use with the Amazon ES domain, such as standard, gp2, io1." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 281 }, "name": "volumeType", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.EbsDeviceVolumeType" } } ], "symbolId": "lib/domain:EbsOptions" }, "@aws-cdk/aws-elasticsearch.ElasticsearchVersion": { "assembly": "@aws-cdk/aws-elasticsearch", "docs": { "stability": "stable", "summary": "Elasticsearch version.", "example": "const domain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_4,\n ebs: {\n volumeSize: 100,\n volumeType: ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD,\n },\n nodeToNodeEncryption: true,\n encryptionAtRest: {\n enabled: true,\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion", "kind": "class", "locationInModule": { "filename": "lib/domain.ts", "line": 22 }, "methods": [ { "docs": { "stability": "stable", "summary": "Custom Elasticsearch version." }, "locationInModule": { "filename": "lib/domain.ts", "line": 122 }, "name": "of", "parameters": [ { "docs": { "summary": "custom version number." }, "name": "version", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, "static": true } ], "name": "ElasticsearchVersion", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 1.5." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 26 }, "name": "V1_5", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 2.3." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 31 }, "name": "V2_3", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 5.1." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 36 }, "name": "V5_1", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 5.3." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 41 }, "name": "V5_3", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 5.5." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 46 }, "name": "V5_5", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 5.6." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 51 }, "name": "V5_6", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 6.0." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 56 }, "name": "V6_0", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 6.2." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 61 }, "name": "V6_2", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 6.3." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 66 }, "name": "V6_3", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 6.4." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 71 }, "name": "V6_4", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 6.5." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 76 }, "name": "V6_5", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 6.7." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 81 }, "name": "V6_7", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 6.8." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 86 }, "name": "V6_8", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 7.1." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 91 }, "name": "V7_1", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 7.10." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 116 }, "name": "V7_10", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 7.4." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 96 }, "name": "V7_4", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 7.7." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 101 }, "name": "V7_7", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 7.8." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 106 }, "name": "V7_8", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "AWS Elasticsearch 7.9." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 111 }, "name": "V7_9", "static": true, "type": { "fqn": "@aws-cdk/aws-elasticsearch.ElasticsearchVersion" } }, { "docs": { "stability": "stable", "summary": "Elasticsearch version number." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 128 }, "name": "version", "type": { "primitive": "string" } } ], "symbolId": "lib/domain:ElasticsearchVersion" }, "@aws-cdk/aws-elasticsearch.EncryptionAtRestOptions": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "deprecated": "use opensearchservice module instead", "remarks": "Can only be used to create a new domain,\nnot update an existing one. Requires Elasticsearch version 5.1 or later.", "stability": "deprecated", "summary": "Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service (KMS) key to use.", "example": "const domain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_1,\n enforceHttps: true,\n nodeToNodeEncryption: true,\n encryptionAtRest: {\n enabled: true,\n },\n fineGrainedAccessControl: {\n masterUserName: 'master-user',\n },\n});\n\nconst masterUserPassword = domain.masterUserPassword;", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-elasticsearch.EncryptionAtRestOptions", "kind": "interface", "locationInModule": { "filename": "lib/domain.ts", "line": 366 }, "name": "EncryptionAtRestOptions", "properties": [ { "abstract": true, "docs": { "default": "- encryption at rest is disabled.", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Specify true to enable encryption at rest." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 373 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- uses default aws/es KMS key.", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Supply if using KMS key for encryption at rest." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 381 }, "name": "kmsKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } } ], "symbolId": "lib/domain:EncryptionAtRestOptions" }, "@aws-cdk/aws-elasticsearch.IDomain": { "assembly": "@aws-cdk/aws-elasticsearch", "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "An interface that represents an Elasticsearch domain - either created with the CDK, or an existing one." }, "fqn": "@aws-cdk/aws-elasticsearch.IDomain", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/domain.ts", "line": 706 }, "methods": [ { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant read permissions for an index in this domain to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 766 }, "name": "grantIndexRead", "parameters": [ { "docs": { "summary": "The index to grant permissions for." }, "name": "index", "type": { "primitive": "string" } }, { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 786 }, "name": "grantIndexReadWrite", "parameters": [ { "docs": { "summary": "The index to grant permissions for." }, "name": "index", "type": { "primitive": "string" } }, { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant write permissions for an index in this domain to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 776 }, "name": "grantIndexWrite", "parameters": [ { "docs": { "summary": "The index to grant permissions for." }, "name": "index", "type": { "primitive": "string" } }, { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 796 }, "name": "grantPathRead", "parameters": [ { "docs": { "summary": "The path to grant permissions for." }, "name": "path", "type": { "primitive": "string" } }, { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 816 }, "name": "grantPathReadWrite", "parameters": [ { "docs": { "summary": "The path to grant permissions for." }, "name": "path", "type": { "primitive": "string" } }, { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 806 }, "name": "grantPathWrite", "parameters": [ { "docs": { "summary": "The path to grant permissions for." }, "name": "path", "type": { "primitive": "string" } }, { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 738 }, "name": "grantRead", "parameters": [ { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 756 }, "name": "grantReadWrite", "parameters": [ { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User)." }, "locationInModule": { "filename": "lib/domain.ts", "line": 747 }, "name": "grantWrite", "parameters": [ { "docs": { "summary": "The principal." }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "abstract": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Return the given named metric for this Domain." }, "locationInModule": { "filename": "lib/domain.ts", "line": 823 }, "name": "metric", "parameters": [ { "name": "metricName", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for automated snapshot failures." }, "locationInModule": { "filename": "lib/domain.ts", "line": 871 }, "name": "metricAutomatedSnapshotFailure", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "maximum over 1 minute", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for the cluster blocking index writes." }, "locationInModule": { "filename": "lib/domain.ts", "line": 855 }, "name": "metricClusterIndexWritesBlocked", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for the time the cluster status is red." }, "locationInModule": { "filename": "lib/domain.ts", "line": 831 }, "name": "metricClusterStatusRed", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for the time the cluster status is yellow." }, "locationInModule": { "filename": "lib/domain.ts", "line": 839 }, "name": "metricClusterStatusYellow", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for CPU utilization." }, "locationInModule": { "filename": "lib/domain.ts", "line": 879 }, "name": "metricCPUUtilization", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "minimum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for the storage space of nodes in the cluster." }, "locationInModule": { "filename": "lib/domain.ts", "line": 847 }, "name": "metricFreeStorageSpace", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "p99 over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for indexing latency." }, "locationInModule": { "filename": "lib/domain.ts", "line": 943 }, "name": "metricIndexingLatency", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for JVM memory pressure." }, "locationInModule": { "filename": "lib/domain.ts", "line": 887 }, "name": "metricJVMMemoryPressure", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for KMS key errors." }, "locationInModule": { "filename": "lib/domain.ts", "line": 911 }, "name": "metricKMSKeyError", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for KMS key being inaccessible." }, "locationInModule": { "filename": "lib/domain.ts", "line": 919 }, "name": "metricKMSKeyInaccessible", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for master CPU utilization." }, "locationInModule": { "filename": "lib/domain.ts", "line": 895 }, "name": "metricMasterCPUUtilization", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for master JVM memory pressure." }, "locationInModule": { "filename": "lib/domain.ts", "line": 903 }, "name": "metricMasterJVMMemoryPressure", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "minimum over 1 hour", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for the number of nodes." }, "locationInModule": { "filename": "lib/domain.ts", "line": 863 }, "name": "metricNodes", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "maximum over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for number of searchable documents." }, "locationInModule": { "filename": "lib/domain.ts", "line": 927 }, "name": "metricSearchableDocuments", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "p99 over 5 minutes", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Metric for search latency." }, "locationInModule": { "filename": "lib/domain.ts", "line": 935 }, "name": "metricSearchLatency", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } } ], "name": "IDomain", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Arn of the Elasticsearch domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 713 }, "name": "domainArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Endpoint of the Elasticsearch domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 729 }, "name": "domainEndpoint", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Domain name of the Elasticsearch domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 721 }, "name": "domainName", "type": { "primitive": "string" } } ], "symbolId": "lib/domain:IDomain" }, "@aws-cdk/aws-elasticsearch.LoggingOptions": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Configures log settings for the domain.", "example": "const prodDomain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_1,\n capacity: {\n masterNodes: 5,\n dataNodes: 20,\n },\n ebs: {\n volumeSize: 20,\n },\n zoneAwareness: {\n availabilityZoneCount: 3,\n },\n logging: {\n slowSearchLogEnabled: true,\n appLogEnabled: true,\n slowIndexLogEnabled: true,\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-elasticsearch.LoggingOptions", "kind": "interface", "locationInModule": { "filename": "lib/domain.ts", "line": 289 }, "name": "LoggingOptions", "properties": [ { "abstract": true, "docs": { "default": "- false", "deprecated": "use opensearchservice module instead", "remarks": "Requires Elasticsearch version 5.1 or later.", "stability": "deprecated", "summary": "Specify if Elasticsearch application logging should be set up." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 331 }, "name": "appLogEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- a new log group is created if app logging is enabled", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Log Elasticsearch application logs to this log group." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 339 }, "name": "appLogGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } }, { "abstract": true, "docs": { "default": "- false", "deprecated": "use opensearchservice module instead", "remarks": "Requires Elasticsearch version 6.7 or later and fine grained access control to be enabled.", "stability": "deprecated", "summary": "Specify if Elasticsearch audit logging should be set up." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 348 }, "name": "auditLogEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- a new log group is created if audit logging is enabled", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Log Elasticsearch audit logs to this log group." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 356 }, "name": "auditLogGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } }, { "abstract": true, "docs": { "default": "- false", "deprecated": "use opensearchservice module instead", "remarks": "Requires Elasticsearch version 5.1 or later.", "stability": "deprecated", "summary": "Specify if slow index logging should be set up." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 314 }, "name": "slowIndexLogEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- a new log group is created if slow index logging is enabled", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Log slow indices to this log group." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 322 }, "name": "slowIndexLogGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } }, { "abstract": true, "docs": { "default": "- false", "deprecated": "use opensearchservice module instead", "remarks": "Requires Elasticsearch version 5.1 or later.", "stability": "deprecated", "summary": "Specify if slow search logging should be set up." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 297 }, "name": "slowSearchLogEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- a new log group is created if slow search logging is enabled", "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Log slow searches to this log group." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 305 }, "name": "slowSearchLogGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } } ], "symbolId": "lib/domain:LoggingOptions" }, "@aws-cdk/aws-elasticsearch.TLSSecurityPolicy": { "assembly": "@aws-cdk/aws-elasticsearch", "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "The minimum TLS version required for traffic to the domain." }, "fqn": "@aws-cdk/aws-elasticsearch.TLSSecurityPolicy", "kind": "enum", "locationInModule": { "filename": "lib/domain.ts", "line": 418 }, "members": [ { "docs": { "stability": "deprecated", "summary": "Cipher suite TLS 1.0." }, "name": "TLS_1_0" }, { "docs": { "stability": "deprecated", "summary": "Cipher suite TLS 1.2." }, "name": "TLS_1_2" } ], "name": "TLSSecurityPolicy", "symbolId": "lib/domain:TLSSecurityPolicy" }, "@aws-cdk/aws-elasticsearch.ZoneAwarenessConfig": { "assembly": "@aws-cdk/aws-elasticsearch", "datatype": true, "docs": { "deprecated": "use opensearchservice module instead", "stability": "deprecated", "summary": "Specifies zone awareness configuration options.", "example": "const prodDomain = new es.Domain(this, 'Domain', {\n version: es.ElasticsearchVersion.V7_1,\n capacity: {\n masterNodes: 5,\n dataNodes: 20,\n },\n ebs: {\n volumeSize: 20,\n },\n zoneAwareness: {\n availabilityZoneCount: 3,\n },\n logging: {\n slowSearchLogEnabled: true,\n appLogEnabled: true,\n slowIndexLogEnabled: true,\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-elasticsearch.ZoneAwarenessConfig", "kind": "interface", "locationInModule": { "filename": "lib/domain.ts", "line": 203 }, "name": "ZoneAwarenessConfig", "properties": [ { "abstract": true, "docs": { "default": "- 2 if zone awareness is enabled.", "deprecated": "use opensearchservice module instead", "remarks": "Valid values are 2 and 3.", "stability": "deprecated", "summary": "If you enabled multiple Availability Zones (AZs), the number of AZs that you want the domain to use." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 227 }, "name": "availabilityZoneCount", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- false", "deprecated": "use opensearchservice module instead", "remarks": "When you enable zone awareness, Amazon ES allocates the nodes and replica\nindex shards that belong to a cluster across two Availability Zones (AZs)\nin the same region to prevent data loss and minimize downtime in the event\nof node or data center failure. Don't enable zone awareness if your cluster\nhas no replica index shards or is a single-node cluster. For more information,\nsee [Configuring a Multi-AZ Domain]\n(https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-managedomains-multiaz)\nin the Amazon Elasticsearch Service Developer Guide.", "stability": "deprecated", "summary": "Indicates whether to enable zone awareness for the Amazon ES domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 218 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/domain:ZoneAwarenessConfig" } }, "version": "1.204.0", "fingerprint": "**********" }