diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/OpenSearchIpAddressTypeIntegDefaultTestDeployAssertE117ADBF.assets.json b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/OpenSearchIpAddressTypeIntegDefaultTestDeployAssertE117ADBF.assets.json new file mode 100644 index 0000000000000..0f6109b205d86 --- /dev/null +++ b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/OpenSearchIpAddressTypeIntegDefaultTestDeployAssertE117ADBF.assets.json @@ -0,0 +1,19 @@ +{ + "version": "36.0.0", + "files": { + "21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22": { + "source": { + "path": "OpenSearchIpAddressTypeIntegDefaultTestDeployAssertE117ADBF.template.json", + "packaging": "file" + }, + "destinations": { + "current_account-current_region": { + "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}", + "objectKey": "21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22.json", + "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}" + } + } + } + }, + "dockerImages": {} +} \ No newline at end of file diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/OpenSearchIpAddressTypeIntegDefaultTestDeployAssertE117ADBF.template.json b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/OpenSearchIpAddressTypeIntegDefaultTestDeployAssertE117ADBF.template.json new file mode 100644 index 0000000000000..ad9d0fb73d1dd --- /dev/null +++ b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/OpenSearchIpAddressTypeIntegDefaultTestDeployAssertE117ADBF.template.json @@ -0,0 +1,36 @@ +{ + "Parameters": { + "BootstrapVersion": { + "Type": "AWS::SSM::Parameter::Value", + "Default": "/cdk-bootstrap/hnb659fds/version", + "Description": "Version of the CDK Bootstrap resources in this environment, automatically retrieved from SSM Parameter Store. [cdk:skip]" + } + }, + "Rules": { + "CheckBootstrapVersion": { + "Assertions": [ + { + "Assert": { + "Fn::Not": [ + { + "Fn::Contains": [ + [ + "1", + "2", + "3", + "4", + "5" + ], + { + "Ref": "BootstrapVersion" + } + ] + } + ] + }, + "AssertDescription": "CDK bootstrap stack version 6 required. Please run 'cdk bootstrap' with a recent version of the CDK CLI." + } + ] + } + } +} \ No newline at end of file diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/cdk-integ-opensearch-ip-address-type.assets.json b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/cdk-integ-opensearch-ip-address-type.assets.json new file mode 100644 index 0000000000000..4523e146791fe --- /dev/null +++ b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/cdk-integ-opensearch-ip-address-type.assets.json @@ -0,0 +1,19 @@ +{ + "version": "36.0.0", + "files": { + "a02f068bda7a4c283f49c26481ad324b0f7a0e54d84de7a1e843d408c8864707": { + "source": { + "path": "cdk-integ-opensearch-ip-address-type.template.json", + "packaging": "file" + }, + "destinations": { + "current_account-current_region": { + "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}", + "objectKey": "a02f068bda7a4c283f49c26481ad324b0f7a0e54d84de7a1e843d408c8864707.json", + "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}" + } + } + } + }, + "dockerImages": {} +} \ No newline at end of file diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/cdk-integ-opensearch-ip-address-type.template.json b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/cdk-integ-opensearch-ip-address-type.template.json new file mode 100644 index 0000000000000..a2b5c8b01431f --- /dev/null +++ b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/cdk-integ-opensearch-ip-address-type.template.json @@ -0,0 +1,102 @@ +{ + "Resources": { + "IPv41075180A": { + "Type": "AWS::OpenSearchService::Domain", + "Properties": { + "ClusterConfig": { + "DedicatedMasterEnabled": false, + "InstanceCount": 1, + "InstanceType": "r5.large.search", + "MultiAZWithStandbyEnabled": false, + "ZoneAwarenessEnabled": false + }, + "DomainEndpointOptions": { + "EnforceHTTPS": false, + "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07" + }, + "EBSOptions": { + "EBSEnabled": true, + "VolumeSize": 10, + "VolumeType": "gp2" + }, + "EncryptionAtRestOptions": { + "Enabled": false + }, + "EngineVersion": "Elasticsearch_7.1", + "IPAddressType": "ipv4", + "LogPublishingOptions": {}, + "NodeToNodeEncryptionOptions": { + "Enabled": false + } + }, + "UpdateReplacePolicy": "Delete", + "DeletionPolicy": "Delete" + }, + "DualStackC64A8AC0": { + "Type": "AWS::OpenSearchService::Domain", + "Properties": { + "ClusterConfig": { + "DedicatedMasterEnabled": false, + "InstanceCount": 1, + "InstanceType": "r5.large.search", + "MultiAZWithStandbyEnabled": false, + "ZoneAwarenessEnabled": false + }, + "DomainEndpointOptions": { + "EnforceHTTPS": false, + "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07" + }, + "EBSOptions": { + "EBSEnabled": true, + "VolumeSize": 10, + "VolumeType": "gp2" + }, + "EncryptionAtRestOptions": { + "Enabled": false + }, + "EngineVersion": "Elasticsearch_7.1", + "IPAddressType": "dualstack", + "LogPublishingOptions": {}, + "NodeToNodeEncryptionOptions": { + "Enabled": false + } + }, + "UpdateReplacePolicy": "Delete", + "DeletionPolicy": "Delete" + } + }, + "Parameters": { + "BootstrapVersion": { + "Type": "AWS::SSM::Parameter::Value", + "Default": "/cdk-bootstrap/hnb659fds/version", + "Description": "Version of the CDK Bootstrap resources in this environment, automatically retrieved from SSM Parameter Store. [cdk:skip]" + } + }, + "Rules": { + "CheckBootstrapVersion": { + "Assertions": [ + { + "Assert": { + "Fn::Not": [ + { + "Fn::Contains": [ + [ + "1", + "2", + "3", + "4", + "5" + ], + { + "Ref": "BootstrapVersion" + } + ] + } + ] + }, + "AssertDescription": "CDK bootstrap stack version 6 required. Please run 'cdk bootstrap' with a recent version of the CDK CLI." + } + ] + } + } +} \ No newline at end of file diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/cdk.out b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/cdk.out new file mode 100644 index 0000000000000..1f0068d32659a --- /dev/null +++ b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/cdk.out @@ -0,0 +1 @@ +{"version":"36.0.0"} \ No newline at end of file diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/integ.json b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/integ.json new file mode 100644 index 0000000000000..b7328ad7852a4 --- /dev/null +++ b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/integ.json @@ -0,0 +1,13 @@ +{ + "version": "36.0.0", + "testCases": { + "OpenSearchIpAddressTypeInteg/DefaultTest": { + "stacks": [ + "cdk-integ-opensearch-ip-address-type" + ], + "diffAssets": true, + "assertionStack": "OpenSearchIpAddressTypeInteg/DefaultTest/DeployAssert", + "assertionStackName": "OpenSearchIpAddressTypeIntegDefaultTestDeployAssertE117ADBF" + } + } +} \ No newline at end of file diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/manifest.json b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/manifest.json new file mode 100644 index 0000000000000..e8c7ad5c4ab2b --- /dev/null +++ b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/manifest.json @@ -0,0 +1,119 @@ +{ + "version": "36.0.0", + "artifacts": { + "cdk-integ-opensearch-ip-address-type.assets": { + "type": "cdk:asset-manifest", + "properties": { + "file": "cdk-integ-opensearch-ip-address-type.assets.json", + "requiresBootstrapStackVersion": 6, + "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version" + } + }, + "cdk-integ-opensearch-ip-address-type": { + "type": "aws:cloudformation:stack", + "environment": "aws://unknown-account/unknown-region", + "properties": { + "templateFile": "cdk-integ-opensearch-ip-address-type.template.json", + "terminationProtection": false, + "validateOnSynth": false, + "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-deploy-role-${AWS::AccountId}-${AWS::Region}", + "cloudFormationExecutionRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-cfn-exec-role-${AWS::AccountId}-${AWS::Region}", + "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/a02f068bda7a4c283f49c26481ad324b0f7a0e54d84de7a1e843d408c8864707.json", + "requiresBootstrapStackVersion": 6, + "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version", + "additionalDependencies": [ + "cdk-integ-opensearch-ip-address-type.assets" + ], + "lookupRole": { + "arn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-lookup-role-${AWS::AccountId}-${AWS::Region}", + "requiresBootstrapStackVersion": 8, + "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version" + } + }, + "dependencies": [ + "cdk-integ-opensearch-ip-address-type.assets" + ], + "metadata": { + "/cdk-integ-opensearch-ip-address-type/IPv4/Resource": [ + { + "type": "aws:cdk:logicalId", + "data": "IPv41075180A" + } + ], + "/cdk-integ-opensearch-ip-address-type/DualStack/Resource": [ + { + "type": "aws:cdk:logicalId", + "data": "DualStackC64A8AC0" + } + ], + "/cdk-integ-opensearch-ip-address-type/BootstrapVersion": [ + { + "type": "aws:cdk:logicalId", + "data": "BootstrapVersion" + } + ], + "/cdk-integ-opensearch-ip-address-type/CheckBootstrapVersion": [ + { + "type": "aws:cdk:logicalId", + "data": "CheckBootstrapVersion" + } + ] + }, + "displayName": "cdk-integ-opensearch-ip-address-type" + }, + "OpenSearchIpAddressTypeIntegDefaultTestDeployAssertE117ADBF.assets": { + "type": "cdk:asset-manifest", + "properties": { + "file": "OpenSearchIpAddressTypeIntegDefaultTestDeployAssertE117ADBF.assets.json", + "requiresBootstrapStackVersion": 6, + "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version" + } + }, + "OpenSearchIpAddressTypeIntegDefaultTestDeployAssertE117ADBF": { + "type": "aws:cloudformation:stack", + "environment": "aws://unknown-account/unknown-region", + "properties": { + "templateFile": "OpenSearchIpAddressTypeIntegDefaultTestDeployAssertE117ADBF.template.json", + "terminationProtection": false, + "validateOnSynth": false, + "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-deploy-role-${AWS::AccountId}-${AWS::Region}", + "cloudFormationExecutionRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-cfn-exec-role-${AWS::AccountId}-${AWS::Region}", + "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22.json", + "requiresBootstrapStackVersion": 6, + "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version", + "additionalDependencies": [ + "OpenSearchIpAddressTypeIntegDefaultTestDeployAssertE117ADBF.assets" + ], + "lookupRole": { + "arn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-lookup-role-${AWS::AccountId}-${AWS::Region}", + "requiresBootstrapStackVersion": 8, + "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version" + } + }, + "dependencies": [ + "OpenSearchIpAddressTypeIntegDefaultTestDeployAssertE117ADBF.assets" + ], + "metadata": { + "/OpenSearchIpAddressTypeInteg/DefaultTest/DeployAssert/BootstrapVersion": [ + { + "type": "aws:cdk:logicalId", + "data": "BootstrapVersion" + } + ], + "/OpenSearchIpAddressTypeInteg/DefaultTest/DeployAssert/CheckBootstrapVersion": [ + { + "type": "aws:cdk:logicalId", + "data": "CheckBootstrapVersion" + } + ] + }, + "displayName": "OpenSearchIpAddressTypeInteg/DefaultTest/DeployAssert" + }, + "Tree": { + "type": "cdk:tree", + "properties": { + "file": "tree.json" + } + } + } +} \ No newline at end of file diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/tree.json b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/tree.json new file mode 100644 index 0000000000000..d63d22e85d867 --- /dev/null +++ b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.js.snapshot/tree.json @@ -0,0 +1,197 @@ +{ + "version": "tree-0.1", + "tree": { + "id": "App", + "path": "", + "children": { + "cdk-integ-opensearch-ip-address-type": { + "id": "cdk-integ-opensearch-ip-address-type", + "path": "cdk-integ-opensearch-ip-address-type", + "children": { + "IPv4": { + "id": "IPv4", + "path": "cdk-integ-opensearch-ip-address-type/IPv4", + "children": { + "Resource": { + "id": "Resource", + "path": "cdk-integ-opensearch-ip-address-type/IPv4/Resource", + "attributes": { + "aws:cdk:cloudformation:type": "AWS::OpenSearchService::Domain", + "aws:cdk:cloudformation:props": { + "clusterConfig": { + "dedicatedMasterEnabled": false, + "instanceCount": 1, + "instanceType": "r5.large.search", + "multiAzWithStandbyEnabled": false, + "zoneAwarenessEnabled": false + }, + "domainEndpointOptions": { + "enforceHttps": false, + "tlsSecurityPolicy": "Policy-Min-TLS-1-0-2019-07" + }, + "ebsOptions": { + "ebsEnabled": true, + "volumeSize": 10, + "volumeType": "gp2" + }, + "encryptionAtRestOptions": { + "enabled": false + }, + "engineVersion": "Elasticsearch_7.1", + "ipAddressType": "ipv4", + "logPublishingOptions": {}, + "nodeToNodeEncryptionOptions": { + "enabled": false + } + } + }, + "constructInfo": { + "fqn": "constructs.Construct", + "version": "10.3.0" + } + } + }, + "constructInfo": { + "fqn": "constructs.Construct", + "version": "10.3.0" + } + }, + "DualStack": { + "id": "DualStack", + "path": "cdk-integ-opensearch-ip-address-type/DualStack", + "children": { + "Resource": { + "id": "Resource", + "path": "cdk-integ-opensearch-ip-address-type/DualStack/Resource", + "attributes": { + "aws:cdk:cloudformation:type": "AWS::OpenSearchService::Domain", + "aws:cdk:cloudformation:props": { + "clusterConfig": { + "dedicatedMasterEnabled": false, + "instanceCount": 1, + "instanceType": "r5.large.search", + "multiAzWithStandbyEnabled": false, + "zoneAwarenessEnabled": false + }, + "domainEndpointOptions": { + "enforceHttps": false, + "tlsSecurityPolicy": "Policy-Min-TLS-1-0-2019-07" + }, + "ebsOptions": { + "ebsEnabled": true, + "volumeSize": 10, + "volumeType": "gp2" + }, + "encryptionAtRestOptions": { + "enabled": false + }, + "engineVersion": "Elasticsearch_7.1", + "ipAddressType": "dualstack", + "logPublishingOptions": {}, + "nodeToNodeEncryptionOptions": { + "enabled": false + } + } + }, + "constructInfo": { + "fqn": "constructs.Construct", + "version": "10.3.0" + } + } + }, + "constructInfo": { + "fqn": "constructs.Construct", + "version": "10.3.0" + } + }, + "BootstrapVersion": { + "id": "BootstrapVersion", + "path": "cdk-integ-opensearch-ip-address-type/BootstrapVersion", + "constructInfo": { + "fqn": "constructs.Construct", + "version": "10.3.0" + } + }, + "CheckBootstrapVersion": { + "id": "CheckBootstrapVersion", + "path": "cdk-integ-opensearch-ip-address-type/CheckBootstrapVersion", + "constructInfo": { + "fqn": "constructs.Construct", + "version": "10.3.0" + } + } + }, + "constructInfo": { + "fqn": "constructs.Construct", + "version": "10.3.0" + } + }, + "OpenSearchIpAddressTypeInteg": { + "id": "OpenSearchIpAddressTypeInteg", + "path": "OpenSearchIpAddressTypeInteg", + "children": { + "DefaultTest": { + "id": "DefaultTest", + "path": "OpenSearchIpAddressTypeInteg/DefaultTest", + "children": { + "Default": { + "id": "Default", + "path": "OpenSearchIpAddressTypeInteg/DefaultTest/Default", + "constructInfo": { + "fqn": "constructs.Construct", + "version": "10.3.0" + } + }, + "DeployAssert": { + "id": "DeployAssert", + "path": "OpenSearchIpAddressTypeInteg/DefaultTest/DeployAssert", + "children": { + "BootstrapVersion": { + "id": "BootstrapVersion", + "path": "OpenSearchIpAddressTypeInteg/DefaultTest/DeployAssert/BootstrapVersion", + "constructInfo": { + "fqn": "constructs.Construct", + "version": "10.3.0" + } + }, + "CheckBootstrapVersion": { + "id": "CheckBootstrapVersion", + "path": "OpenSearchIpAddressTypeInteg/DefaultTest/DeployAssert/CheckBootstrapVersion", + "constructInfo": { + "fqn": "constructs.Construct", + "version": "10.3.0" + } + } + }, + "constructInfo": { + "fqn": "constructs.Construct", + "version": "10.3.0" + } + } + }, + "constructInfo": { + "fqn": "@aws-cdk/integ-tests-alpha.IntegTestCase", + "version": "0.0.0" + } + } + }, + "constructInfo": { + "fqn": "@aws-cdk/integ-tests-alpha.IntegTest", + "version": "0.0.0" + } + }, + "Tree": { + "id": "Tree", + "path": "Tree", + "constructInfo": { + "fqn": "constructs.Construct", + "version": "10.3.0" + } + } + }, + "constructInfo": { + "fqn": "constructs.Construct", + "version": "10.3.0" + } + } +} \ No newline at end of file diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.ts new file mode 100644 index 0000000000000..aad2005691675 --- /dev/null +++ b/packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ip-address-type.ts @@ -0,0 +1,37 @@ +import { App, RemovalPolicy, Stack, StackProps } from 'aws-cdk-lib'; +import { Construct } from 'constructs'; +import * as opensearch from 'aws-cdk-lib/aws-opensearchservice'; +import { IntegTest } from '@aws-cdk/integ-tests-alpha'; + +class TestStack extends Stack { + constructor(scope: Construct, id: string, props?: StackProps) { + super(scope, id, props); + + new opensearch.Domain(this, 'IPv4', { + version: opensearch.EngineVersion.ELASTICSEARCH_7_1, + removalPolicy: RemovalPolicy.DESTROY, + ipAddressType: opensearch.IpAddressType.IPV4, + capacity: { + multiAzWithStandbyEnabled: false, + }, + }); + + new opensearch.Domain(this, 'DualStack', { + version: opensearch.EngineVersion.ELASTICSEARCH_7_1, + removalPolicy: RemovalPolicy.DESTROY, + ipAddressType: opensearch.IpAddressType.DUAL_STACK, + capacity: { + multiAzWithStandbyEnabled: false, + }, + }); + } +} + +const app = new App(); +const stack = new TestStack(app, 'cdk-integ-opensearch-ip-address-type'); + +new IntegTest(app, 'OpenSearchIpAddressTypeInteg', { + testCases: [stack], + diffAssets: true, +}); +app.synth(); \ No newline at end of file diff --git a/packages/aws-cdk-lib/aws-opensearchservice/README.md b/packages/aws-cdk-lib/aws-opensearchservice/README.md index bb5cf3f7f3bc6..9078815c579e8 100644 --- a/packages/aws-cdk-lib/aws-opensearchservice/README.md +++ b/packages/aws-cdk-lib/aws-opensearchservice/README.md @@ -36,7 +36,6 @@ const gp3Domain = new Domain(this, 'Domain', { }); ``` - Create a production grade cluster by also specifying things like capacity and az distribution ```ts @@ -473,4 +472,15 @@ const domain = new Domain(this, 'Domain', { version: EngineVersion.OPENSEARCH_1_3, enableAutoSoftwareUpdate: true, }); -``` \ No newline at end of file +``` + +## IP address type + +You can specify either dual stack or IPv4 as your IP address type. + +```ts +const domain = new Domain(this, 'Domain', { + version: EngineVersion.OPENSEARCH_1_3, + ipAddressType: IpAddressType.DUAL_STACK, +}); +``` diff --git a/packages/aws-cdk-lib/aws-opensearchservice/lib/domain.ts b/packages/aws-cdk-lib/aws-opensearchservice/lib/domain.ts index 830ed96724fed..154f849647ea1 100644 --- a/packages/aws-cdk-lib/aws-opensearchservice/lib/domain.ts +++ b/packages/aws-cdk-lib/aws-opensearchservice/lib/domain.ts @@ -423,6 +423,20 @@ export interface WindowStartTime { readonly minutes: number; } +/** + * The IP address type for the domain. + */ +export enum IpAddressType { + /** + * IPv4 addresses only + */ + IPV4 = 'ipv4', + /** + * IPv4 and IPv6 addresses + */ + DUAL_STACK = 'dualstack', +} + /** * Properties for an Amazon OpenSearch Service domain. */ @@ -642,6 +656,16 @@ export interface DomainProps { * @default - false */ readonly enableAutoSoftwareUpdate?: boolean; + + /** + * Specify either dual stack or IPv4 as your IP address type. + * Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. + * + * If you set your IP address type to dual stack, you can't change your address type later. + * + * @default - IpAddressType.IPV4 + */ + readonly ipAddressType?: IpAddressType; } /** @@ -1883,6 +1907,7 @@ export class Domain extends DomainBase implements IDomain, ec2.IConnectable { softwareUpdateOptions: props.enableAutoSoftwareUpdate ? { autoSoftwareUpdateEnabled: props.enableAutoSoftwareUpdate, } : undefined, + ipAddressType: props.ipAddressType, }); this.domain.applyRemovalPolicy(props.removalPolicy); diff --git a/packages/aws-cdk-lib/aws-opensearchservice/test/domain.test.ts b/packages/aws-cdk-lib/aws-opensearchservice/test/domain.test.ts index 58ff9cf1959aa..aab03cc079d1d 100644 --- a/packages/aws-cdk-lib/aws-opensearchservice/test/domain.test.ts +++ b/packages/aws-cdk-lib/aws-opensearchservice/test/domain.test.ts @@ -10,7 +10,7 @@ import * as logs from '../../aws-logs'; import * as route53 from '../../aws-route53'; import { App, Stack, Duration, SecretValue, CfnParameter, Token } from '../../core'; import * as cxapi from '../../cx-api'; -import { Domain, DomainProps, EngineVersion } from '../lib'; +import { Domain, DomainProps, EngineVersion, IpAddressType } from '../lib'; let app: App; let stack: Stack; @@ -2468,6 +2468,20 @@ describe('EBS Options Configurations', () => { }); }); +each([ + [IpAddressType.IPV4, 'ipv4'], + [IpAddressType.DUAL_STACK, 'dualstack'], +]).test('ip address type', (type, expected) => { + new Domain(stack, 'Domain', { + version: EngineVersion.OPENSEARCH_2_5, + ipAddressType: type, + }); + + Template.fromStack(stack).hasResourceProperties('AWS::OpenSearchService::Domain', { + IPAddressType: expected, + }); +}); + function testGrant( expectedActions: string[], invocation: (user: iam.IPrincipal, domain: Domain) => void, diff --git a/packages/aws-cdk-lib/rosetta/aws_opensearchservice/default.ts-fixture b/packages/aws-cdk-lib/rosetta/aws_opensearchservice/default.ts-fixture index de5a6b7d22adc..c42bafd5f482a 100644 --- a/packages/aws-cdk-lib/rosetta/aws_opensearchservice/default.ts-fixture +++ b/packages/aws-cdk-lib/rosetta/aws_opensearchservice/default.ts-fixture @@ -1,7 +1,7 @@ // Fixture with packages imported, but nothing else import { Construct } from 'constructs'; import { RemovalPolicy, Stack, Fn } from 'aws-cdk-lib'; -import { Domain, DomainProps, EngineVersion } from 'aws-cdk-lib/aws-opensearchservice'; +import { Domain, DomainProps, EngineVersion, IpAddressType } from 'aws-cdk-lib/aws-opensearchservice'; import * as lambda from 'aws-cdk-lib/aws-lambda'; import * as ec2 from 'aws-cdk-lib/aws-ec2'; import * as iam from 'aws-cdk-lib/aws-iam';