- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateDomainCommand
Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains .
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { OpenSearchClient, CreateDomainCommand } from "@aws-sdk/client-opensearch"; // ES Modules import
// const { OpenSearchClient, CreateDomainCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import
const client = new OpenSearchClient(config);
const input = { // CreateDomainRequest
DomainName: "STRING_VALUE", // required
EngineVersion: "STRING_VALUE",
ClusterConfig: { // ClusterConfig
InstanceType: "m3.medium.search" || "m3.large.search" || "m3.xlarge.search" || "m3.2xlarge.search" || "m4.large.search" || "m4.xlarge.search" || "m4.2xlarge.search" || "m4.4xlarge.search" || "m4.10xlarge.search" || "m5.large.search" || "m5.xlarge.search" || "m5.2xlarge.search" || "m5.4xlarge.search" || "m5.12xlarge.search" || "m5.24xlarge.search" || "r5.large.search" || "r5.xlarge.search" || "r5.2xlarge.search" || "r5.4xlarge.search" || "r5.12xlarge.search" || "r5.24xlarge.search" || "c5.large.search" || "c5.xlarge.search" || "c5.2xlarge.search" || "c5.4xlarge.search" || "c5.9xlarge.search" || "c5.18xlarge.search" || "t3.nano.search" || "t3.micro.search" || "t3.small.search" || "t3.medium.search" || "t3.large.search" || "t3.xlarge.search" || "t3.2xlarge.search" || "or1.medium.search" || "or1.large.search" || "or1.xlarge.search" || "or1.2xlarge.search" || "or1.4xlarge.search" || "or1.8xlarge.search" || "or1.12xlarge.search" || "or1.16xlarge.search" || "ultrawarm1.medium.search" || "ultrawarm1.large.search" || "ultrawarm1.xlarge.search" || "t2.micro.search" || "t2.small.search" || "t2.medium.search" || "r3.large.search" || "r3.xlarge.search" || "r3.2xlarge.search" || "r3.4xlarge.search" || "r3.8xlarge.search" || "i2.xlarge.search" || "i2.2xlarge.search" || "d2.xlarge.search" || "d2.2xlarge.search" || "d2.4xlarge.search" || "d2.8xlarge.search" || "c4.large.search" || "c4.xlarge.search" || "c4.2xlarge.search" || "c4.4xlarge.search" || "c4.8xlarge.search" || "r4.large.search" || "r4.xlarge.search" || "r4.2xlarge.search" || "r4.4xlarge.search" || "r4.8xlarge.search" || "r4.16xlarge.search" || "i3.large.search" || "i3.xlarge.search" || "i3.2xlarge.search" || "i3.4xlarge.search" || "i3.8xlarge.search" || "i3.16xlarge.search" || "r6g.large.search" || "r6g.xlarge.search" || "r6g.2xlarge.search" || "r6g.4xlarge.search" || "r6g.8xlarge.search" || "r6g.12xlarge.search" || "m6g.large.search" || "m6g.xlarge.search" || "m6g.2xlarge.search" || "m6g.4xlarge.search" || "m6g.8xlarge.search" || "m6g.12xlarge.search" || "c6g.large.search" || "c6g.xlarge.search" || "c6g.2xlarge.search" || "c6g.4xlarge.search" || "c6g.8xlarge.search" || "c6g.12xlarge.search" || "r6gd.large.search" || "r6gd.xlarge.search" || "r6gd.2xlarge.search" || "r6gd.4xlarge.search" || "r6gd.8xlarge.search" || "r6gd.12xlarge.search" || "r6gd.16xlarge.search" || "t4g.small.search" || "t4g.medium.search",
InstanceCount: Number("int"),
DedicatedMasterEnabled: true || false,
ZoneAwarenessEnabled: true || false,
ZoneAwarenessConfig: { // ZoneAwarenessConfig
AvailabilityZoneCount: Number("int"),
},
DedicatedMasterType: "m3.medium.search" || "m3.large.search" || "m3.xlarge.search" || "m3.2xlarge.search" || "m4.large.search" || "m4.xlarge.search" || "m4.2xlarge.search" || "m4.4xlarge.search" || "m4.10xlarge.search" || "m5.large.search" || "m5.xlarge.search" || "m5.2xlarge.search" || "m5.4xlarge.search" || "m5.12xlarge.search" || "m5.24xlarge.search" || "r5.large.search" || "r5.xlarge.search" || "r5.2xlarge.search" || "r5.4xlarge.search" || "r5.12xlarge.search" || "r5.24xlarge.search" || "c5.large.search" || "c5.xlarge.search" || "c5.2xlarge.search" || "c5.4xlarge.search" || "c5.9xlarge.search" || "c5.18xlarge.search" || "t3.nano.search" || "t3.micro.search" || "t3.small.search" || "t3.medium.search" || "t3.large.search" || "t3.xlarge.search" || "t3.2xlarge.search" || "or1.medium.search" || "or1.large.search" || "or1.xlarge.search" || "or1.2xlarge.search" || "or1.4xlarge.search" || "or1.8xlarge.search" || "or1.12xlarge.search" || "or1.16xlarge.search" || "ultrawarm1.medium.search" || "ultrawarm1.large.search" || "ultrawarm1.xlarge.search" || "t2.micro.search" || "t2.small.search" || "t2.medium.search" || "r3.large.search" || "r3.xlarge.search" || "r3.2xlarge.search" || "r3.4xlarge.search" || "r3.8xlarge.search" || "i2.xlarge.search" || "i2.2xlarge.search" || "d2.xlarge.search" || "d2.2xlarge.search" || "d2.4xlarge.search" || "d2.8xlarge.search" || "c4.large.search" || "c4.xlarge.search" || "c4.2xlarge.search" || "c4.4xlarge.search" || "c4.8xlarge.search" || "r4.large.search" || "r4.xlarge.search" || "r4.2xlarge.search" || "r4.4xlarge.search" || "r4.8xlarge.search" || "r4.16xlarge.search" || "i3.large.search" || "i3.xlarge.search" || "i3.2xlarge.search" || "i3.4xlarge.search" || "i3.8xlarge.search" || "i3.16xlarge.search" || "r6g.large.search" || "r6g.xlarge.search" || "r6g.2xlarge.search" || "r6g.4xlarge.search" || "r6g.8xlarge.search" || "r6g.12xlarge.search" || "m6g.large.search" || "m6g.xlarge.search" || "m6g.2xlarge.search" || "m6g.4xlarge.search" || "m6g.8xlarge.search" || "m6g.12xlarge.search" || "c6g.large.search" || "c6g.xlarge.search" || "c6g.2xlarge.search" || "c6g.4xlarge.search" || "c6g.8xlarge.search" || "c6g.12xlarge.search" || "r6gd.large.search" || "r6gd.xlarge.search" || "r6gd.2xlarge.search" || "r6gd.4xlarge.search" || "r6gd.8xlarge.search" || "r6gd.12xlarge.search" || "r6gd.16xlarge.search" || "t4g.small.search" || "t4g.medium.search",
DedicatedMasterCount: Number("int"),
WarmEnabled: true || false,
WarmType: "ultrawarm1.medium.search" || "ultrawarm1.large.search" || "ultrawarm1.xlarge.search",
WarmCount: Number("int"),
ColdStorageOptions: { // ColdStorageOptions
Enabled: true || false, // required
},
MultiAZWithStandbyEnabled: true || false,
NodeOptions: [ // NodeOptionsList
{ // NodeOption
NodeType: "coordinator",
NodeConfig: { // NodeConfig
Enabled: true || false,
Type: "m3.medium.search" || "m3.large.search" || "m3.xlarge.search" || "m3.2xlarge.search" || "m4.large.search" || "m4.xlarge.search" || "m4.2xlarge.search" || "m4.4xlarge.search" || "m4.10xlarge.search" || "m5.large.search" || "m5.xlarge.search" || "m5.2xlarge.search" || "m5.4xlarge.search" || "m5.12xlarge.search" || "m5.24xlarge.search" || "r5.large.search" || "r5.xlarge.search" || "r5.2xlarge.search" || "r5.4xlarge.search" || "r5.12xlarge.search" || "r5.24xlarge.search" || "c5.large.search" || "c5.xlarge.search" || "c5.2xlarge.search" || "c5.4xlarge.search" || "c5.9xlarge.search" || "c5.18xlarge.search" || "t3.nano.search" || "t3.micro.search" || "t3.small.search" || "t3.medium.search" || "t3.large.search" || "t3.xlarge.search" || "t3.2xlarge.search" || "or1.medium.search" || "or1.large.search" || "or1.xlarge.search" || "or1.2xlarge.search" || "or1.4xlarge.search" || "or1.8xlarge.search" || "or1.12xlarge.search" || "or1.16xlarge.search" || "ultrawarm1.medium.search" || "ultrawarm1.large.search" || "ultrawarm1.xlarge.search" || "t2.micro.search" || "t2.small.search" || "t2.medium.search" || "r3.large.search" || "r3.xlarge.search" || "r3.2xlarge.search" || "r3.4xlarge.search" || "r3.8xlarge.search" || "i2.xlarge.search" || "i2.2xlarge.search" || "d2.xlarge.search" || "d2.2xlarge.search" || "d2.4xlarge.search" || "d2.8xlarge.search" || "c4.large.search" || "c4.xlarge.search" || "c4.2xlarge.search" || "c4.4xlarge.search" || "c4.8xlarge.search" || "r4.large.search" || "r4.xlarge.search" || "r4.2xlarge.search" || "r4.4xlarge.search" || "r4.8xlarge.search" || "r4.16xlarge.search" || "i3.large.search" || "i3.xlarge.search" || "i3.2xlarge.search" || "i3.4xlarge.search" || "i3.8xlarge.search" || "i3.16xlarge.search" || "r6g.large.search" || "r6g.xlarge.search" || "r6g.2xlarge.search" || "r6g.4xlarge.search" || "r6g.8xlarge.search" || "r6g.12xlarge.search" || "m6g.large.search" || "m6g.xlarge.search" || "m6g.2xlarge.search" || "m6g.4xlarge.search" || "m6g.8xlarge.search" || "m6g.12xlarge.search" || "c6g.large.search" || "c6g.xlarge.search" || "c6g.2xlarge.search" || "c6g.4xlarge.search" || "c6g.8xlarge.search" || "c6g.12xlarge.search" || "r6gd.large.search" || "r6gd.xlarge.search" || "r6gd.2xlarge.search" || "r6gd.4xlarge.search" || "r6gd.8xlarge.search" || "r6gd.12xlarge.search" || "r6gd.16xlarge.search" || "t4g.small.search" || "t4g.medium.search",
Count: Number("int"),
},
},
],
},
EBSOptions: { // EBSOptions
EBSEnabled: true || false,
VolumeType: "standard" || "gp2" || "io1" || "gp3",
VolumeSize: Number("int"),
Iops: Number("int"),
Throughput: Number("int"),
},
AccessPolicies: "STRING_VALUE",
IPAddressType: "ipv4" || "dualstack",
SnapshotOptions: { // SnapshotOptions
AutomatedSnapshotStartHour: Number("int"),
},
VPCOptions: { // VPCOptions
SubnetIds: [ // StringList
"STRING_VALUE",
],
SecurityGroupIds: [
"STRING_VALUE",
],
},
CognitoOptions: { // CognitoOptions
Enabled: true || false,
UserPoolId: "STRING_VALUE",
IdentityPoolId: "STRING_VALUE",
RoleArn: "STRING_VALUE",
},
EncryptionAtRestOptions: { // EncryptionAtRestOptions
Enabled: true || false,
KmsKeyId: "STRING_VALUE",
},
NodeToNodeEncryptionOptions: { // NodeToNodeEncryptionOptions
Enabled: true || false,
},
AdvancedOptions: { // AdvancedOptions
"<keys>": "STRING_VALUE",
},
LogPublishingOptions: { // LogPublishingOptions
"<keys>": { // LogPublishingOption
CloudWatchLogsLogGroupArn: "STRING_VALUE",
Enabled: true || false,
},
},
DomainEndpointOptions: { // DomainEndpointOptions
EnforceHTTPS: true || false,
TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07" || "Policy-Min-TLS-1-2-PFS-2023-10",
CustomEndpointEnabled: true || false,
CustomEndpoint: "STRING_VALUE",
CustomEndpointCertificateArn: "STRING_VALUE",
},
AdvancedSecurityOptions: { // AdvancedSecurityOptionsInput
Enabled: true || false,
InternalUserDatabaseEnabled: true || false,
MasterUserOptions: { // MasterUserOptions
MasterUserARN: "STRING_VALUE",
MasterUserName: "STRING_VALUE",
MasterUserPassword: "STRING_VALUE",
},
SAMLOptions: { // SAMLOptionsInput
Enabled: true || false,
Idp: { // SAMLIdp
MetadataContent: "STRING_VALUE", // required
EntityId: "STRING_VALUE", // required
},
MasterUserName: "STRING_VALUE",
MasterBackendRole: "STRING_VALUE",
SubjectKey: "STRING_VALUE",
RolesKey: "STRING_VALUE",
SessionTimeoutMinutes: Number("int"),
},
JWTOptions: { // JWTOptionsInput
Enabled: true || false,
SubjectKey: "STRING_VALUE",
RolesKey: "STRING_VALUE",
PublicKey: "STRING_VALUE",
},
AnonymousAuthEnabled: true || false,
},
IdentityCenterOptions: { // IdentityCenterOptionsInput
EnabledAPIAccess: true || false,
IdentityCenterInstanceARN: "STRING_VALUE",
SubjectKey: "UserName" || "UserId" || "Email",
RolesKey: "GroupName" || "GroupId",
},
TagList: [ // TagList
{ // Tag
Key: "STRING_VALUE", // required
Value: "STRING_VALUE", // required
},
],
AutoTuneOptions: { // AutoTuneOptionsInput
DesiredState: "ENABLED" || "DISABLED",
MaintenanceSchedules: [ // AutoTuneMaintenanceScheduleList
{ // AutoTuneMaintenanceSchedule
StartAt: new Date("TIMESTAMP"),
Duration: { // Duration
Value: Number("long"),
Unit: "HOURS",
},
CronExpressionForRecurrence: "STRING_VALUE",
},
],
UseOffPeakWindow: true || false,
},
OffPeakWindowOptions: { // OffPeakWindowOptions
Enabled: true || false,
OffPeakWindow: { // OffPeakWindow
WindowStartTime: { // WindowStartTime
Hours: Number("long"), // required
Minutes: Number("long"), // required
},
},
},
SoftwareUpdateOptions: { // SoftwareUpdateOptions
AutoSoftwareUpdateEnabled: true || false,
},
AIMLOptions: { // AIMLOptionsInput
NaturalLanguageQueryGenerationOptions: { // NaturalLanguageQueryGenerationOptionsInput
DesiredState: "ENABLED" || "DISABLED",
},
},
};
const command = new CreateDomainCommand(input);
const response = await client.send(command);
// { // CreateDomainResponse
// DomainStatus: { // DomainStatus
// DomainId: "STRING_VALUE", // required
// DomainName: "STRING_VALUE", // required
// ARN: "STRING_VALUE", // required
// Created: true || false,
// Deleted: true || false,
// Endpoint: "STRING_VALUE",
// EndpointV2: "STRING_VALUE",
// Endpoints: { // EndpointsMap
// "<keys>": "STRING_VALUE",
// },
// DomainEndpointV2HostedZoneId: "STRING_VALUE",
// Processing: true || false,
// UpgradeProcessing: true || false,
// EngineVersion: "STRING_VALUE",
// ClusterConfig: { // ClusterConfig
// InstanceType: "m3.medium.search" || "m3.large.search" || "m3.xlarge.search" || "m3.2xlarge.search" || "m4.large.search" || "m4.xlarge.search" || "m4.2xlarge.search" || "m4.4xlarge.search" || "m4.10xlarge.search" || "m5.large.search" || "m5.xlarge.search" || "m5.2xlarge.search" || "m5.4xlarge.search" || "m5.12xlarge.search" || "m5.24xlarge.search" || "r5.large.search" || "r5.xlarge.search" || "r5.2xlarge.search" || "r5.4xlarge.search" || "r5.12xlarge.search" || "r5.24xlarge.search" || "c5.large.search" || "c5.xlarge.search" || "c5.2xlarge.search" || "c5.4xlarge.search" || "c5.9xlarge.search" || "c5.18xlarge.search" || "t3.nano.search" || "t3.micro.search" || "t3.small.search" || "t3.medium.search" || "t3.large.search" || "t3.xlarge.search" || "t3.2xlarge.search" || "or1.medium.search" || "or1.large.search" || "or1.xlarge.search" || "or1.2xlarge.search" || "or1.4xlarge.search" || "or1.8xlarge.search" || "or1.12xlarge.search" || "or1.16xlarge.search" || "ultrawarm1.medium.search" || "ultrawarm1.large.search" || "ultrawarm1.xlarge.search" || "t2.micro.search" || "t2.small.search" || "t2.medium.search" || "r3.large.search" || "r3.xlarge.search" || "r3.2xlarge.search" || "r3.4xlarge.search" || "r3.8xlarge.search" || "i2.xlarge.search" || "i2.2xlarge.search" || "d2.xlarge.search" || "d2.2xlarge.search" || "d2.4xlarge.search" || "d2.8xlarge.search" || "c4.large.search" || "c4.xlarge.search" || "c4.2xlarge.search" || "c4.4xlarge.search" || "c4.8xlarge.search" || "r4.large.search" || "r4.xlarge.search" || "r4.2xlarge.search" || "r4.4xlarge.search" || "r4.8xlarge.search" || "r4.16xlarge.search" || "i3.large.search" || "i3.xlarge.search" || "i3.2xlarge.search" || "i3.4xlarge.search" || "i3.8xlarge.search" || "i3.16xlarge.search" || "r6g.large.search" || "r6g.xlarge.search" || "r6g.2xlarge.search" || "r6g.4xlarge.search" || "r6g.8xlarge.search" || "r6g.12xlarge.search" || "m6g.large.search" || "m6g.xlarge.search" || "m6g.2xlarge.search" || "m6g.4xlarge.search" || "m6g.8xlarge.search" || "m6g.12xlarge.search" || "c6g.large.search" || "c6g.xlarge.search" || "c6g.2xlarge.search" || "c6g.4xlarge.search" || "c6g.8xlarge.search" || "c6g.12xlarge.search" || "r6gd.large.search" || "r6gd.xlarge.search" || "r6gd.2xlarge.search" || "r6gd.4xlarge.search" || "r6gd.8xlarge.search" || "r6gd.12xlarge.search" || "r6gd.16xlarge.search" || "t4g.small.search" || "t4g.medium.search",
// InstanceCount: Number("int"),
// DedicatedMasterEnabled: true || false,
// ZoneAwarenessEnabled: true || false,
// ZoneAwarenessConfig: { // ZoneAwarenessConfig
// AvailabilityZoneCount: Number("int"),
// },
// DedicatedMasterType: "m3.medium.search" || "m3.large.search" || "m3.xlarge.search" || "m3.2xlarge.search" || "m4.large.search" || "m4.xlarge.search" || "m4.2xlarge.search" || "m4.4xlarge.search" || "m4.10xlarge.search" || "m5.large.search" || "m5.xlarge.search" || "m5.2xlarge.search" || "m5.4xlarge.search" || "m5.12xlarge.search" || "m5.24xlarge.search" || "r5.large.search" || "r5.xlarge.search" || "r5.2xlarge.search" || "r5.4xlarge.search" || "r5.12xlarge.search" || "r5.24xlarge.search" || "c5.large.search" || "c5.xlarge.search" || "c5.2xlarge.search" || "c5.4xlarge.search" || "c5.9xlarge.search" || "c5.18xlarge.search" || "t3.nano.search" || "t3.micro.search" || "t3.small.search" || "t3.medium.search" || "t3.large.search" || "t3.xlarge.search" || "t3.2xlarge.search" || "or1.medium.search" || "or1.large.search" || "or1.xlarge.search" || "or1.2xlarge.search" || "or1.4xlarge.search" || "or1.8xlarge.search" || "or1.12xlarge.search" || "or1.16xlarge.search" || "ultrawarm1.medium.search" || "ultrawarm1.large.search" || "ultrawarm1.xlarge.search" || "t2.micro.search" || "t2.small.search" || "t2.medium.search" || "r3.large.search" || "r3.xlarge.search" || "r3.2xlarge.search" || "r3.4xlarge.search" || "r3.8xlarge.search" || "i2.xlarge.search" || "i2.2xlarge.search" || "d2.xlarge.search" || "d2.2xlarge.search" || "d2.4xlarge.search" || "d2.8xlarge.search" || "c4.large.search" || "c4.xlarge.search" || "c4.2xlarge.search" || "c4.4xlarge.search" || "c4.8xlarge.search" || "r4.large.search" || "r4.xlarge.search" || "r4.2xlarge.search" || "r4.4xlarge.search" || "r4.8xlarge.search" || "r4.16xlarge.search" || "i3.large.search" || "i3.xlarge.search" || "i3.2xlarge.search" || "i3.4xlarge.search" || "i3.8xlarge.search" || "i3.16xlarge.search" || "r6g.large.search" || "r6g.xlarge.search" || "r6g.2xlarge.search" || "r6g.4xlarge.search" || "r6g.8xlarge.search" || "r6g.12xlarge.search" || "m6g.large.search" || "m6g.xlarge.search" || "m6g.2xlarge.search" || "m6g.4xlarge.search" || "m6g.8xlarge.search" || "m6g.12xlarge.search" || "c6g.large.search" || "c6g.xlarge.search" || "c6g.2xlarge.search" || "c6g.4xlarge.search" || "c6g.8xlarge.search" || "c6g.12xlarge.search" || "r6gd.large.search" || "r6gd.xlarge.search" || "r6gd.2xlarge.search" || "r6gd.4xlarge.search" || "r6gd.8xlarge.search" || "r6gd.12xlarge.search" || "r6gd.16xlarge.search" || "t4g.small.search" || "t4g.medium.search",
// DedicatedMasterCount: Number("int"),
// WarmEnabled: true || false,
// WarmType: "ultrawarm1.medium.search" || "ultrawarm1.large.search" || "ultrawarm1.xlarge.search",
// WarmCount: Number("int"),
// ColdStorageOptions: { // ColdStorageOptions
// Enabled: true || false, // required
// },
// MultiAZWithStandbyEnabled: true || false,
// NodeOptions: [ // NodeOptionsList
// { // NodeOption
// NodeType: "coordinator",
// NodeConfig: { // NodeConfig
// Enabled: true || false,
// Type: "m3.medium.search" || "m3.large.search" || "m3.xlarge.search" || "m3.2xlarge.search" || "m4.large.search" || "m4.xlarge.search" || "m4.2xlarge.search" || "m4.4xlarge.search" || "m4.10xlarge.search" || "m5.large.search" || "m5.xlarge.search" || "m5.2xlarge.search" || "m5.4xlarge.search" || "m5.12xlarge.search" || "m5.24xlarge.search" || "r5.large.search" || "r5.xlarge.search" || "r5.2xlarge.search" || "r5.4xlarge.search" || "r5.12xlarge.search" || "r5.24xlarge.search" || "c5.large.search" || "c5.xlarge.search" || "c5.2xlarge.search" || "c5.4xlarge.search" || "c5.9xlarge.search" || "c5.18xlarge.search" || "t3.nano.search" || "t3.micro.search" || "t3.small.search" || "t3.medium.search" || "t3.large.search" || "t3.xlarge.search" || "t3.2xlarge.search" || "or1.medium.search" || "or1.large.search" || "or1.xlarge.search" || "or1.2xlarge.search" || "or1.4xlarge.search" || "or1.8xlarge.search" || "or1.12xlarge.search" || "or1.16xlarge.search" || "ultrawarm1.medium.search" || "ultrawarm1.large.search" || "ultrawarm1.xlarge.search" || "t2.micro.search" || "t2.small.search" || "t2.medium.search" || "r3.large.search" || "r3.xlarge.search" || "r3.2xlarge.search" || "r3.4xlarge.search" || "r3.8xlarge.search" || "i2.xlarge.search" || "i2.2xlarge.search" || "d2.xlarge.search" || "d2.2xlarge.search" || "d2.4xlarge.search" || "d2.8xlarge.search" || "c4.large.search" || "c4.xlarge.search" || "c4.2xlarge.search" || "c4.4xlarge.search" || "c4.8xlarge.search" || "r4.large.search" || "r4.xlarge.search" || "r4.2xlarge.search" || "r4.4xlarge.search" || "r4.8xlarge.search" || "r4.16xlarge.search" || "i3.large.search" || "i3.xlarge.search" || "i3.2xlarge.search" || "i3.4xlarge.search" || "i3.8xlarge.search" || "i3.16xlarge.search" || "r6g.large.search" || "r6g.xlarge.search" || "r6g.2xlarge.search" || "r6g.4xlarge.search" || "r6g.8xlarge.search" || "r6g.12xlarge.search" || "m6g.large.search" || "m6g.xlarge.search" || "m6g.2xlarge.search" || "m6g.4xlarge.search" || "m6g.8xlarge.search" || "m6g.12xlarge.search" || "c6g.large.search" || "c6g.xlarge.search" || "c6g.2xlarge.search" || "c6g.4xlarge.search" || "c6g.8xlarge.search" || "c6g.12xlarge.search" || "r6gd.large.search" || "r6gd.xlarge.search" || "r6gd.2xlarge.search" || "r6gd.4xlarge.search" || "r6gd.8xlarge.search" || "r6gd.12xlarge.search" || "r6gd.16xlarge.search" || "t4g.small.search" || "t4g.medium.search",
// Count: Number("int"),
// },
// },
// ],
// },
// EBSOptions: { // EBSOptions
// EBSEnabled: true || false,
// VolumeType: "standard" || "gp2" || "io1" || "gp3",
// VolumeSize: Number("int"),
// Iops: Number("int"),
// Throughput: Number("int"),
// },
// AccessPolicies: "STRING_VALUE",
// IPAddressType: "ipv4" || "dualstack",
// SnapshotOptions: { // SnapshotOptions
// AutomatedSnapshotStartHour: Number("int"),
// },
// VPCOptions: { // VPCDerivedInfo
// VPCId: "STRING_VALUE",
// SubnetIds: [ // StringList
// "STRING_VALUE",
// ],
// AvailabilityZones: [
// "STRING_VALUE",
// ],
// SecurityGroupIds: [
// "STRING_VALUE",
// ],
// },
// CognitoOptions: { // CognitoOptions
// Enabled: true || false,
// UserPoolId: "STRING_VALUE",
// IdentityPoolId: "STRING_VALUE",
// RoleArn: "STRING_VALUE",
// },
// EncryptionAtRestOptions: { // EncryptionAtRestOptions
// Enabled: true || false,
// KmsKeyId: "STRING_VALUE",
// },
// NodeToNodeEncryptionOptions: { // NodeToNodeEncryptionOptions
// Enabled: true || false,
// },
// AdvancedOptions: { // AdvancedOptions
// "<keys>": "STRING_VALUE",
// },
// LogPublishingOptions: { // LogPublishingOptions
// "<keys>": { // LogPublishingOption
// CloudWatchLogsLogGroupArn: "STRING_VALUE",
// Enabled: true || false,
// },
// },
// ServiceSoftwareOptions: { // ServiceSoftwareOptions
// CurrentVersion: "STRING_VALUE",
// NewVersion: "STRING_VALUE",
// UpdateAvailable: true || false,
// Cancellable: true || false,
// UpdateStatus: "PENDING_UPDATE" || "IN_PROGRESS" || "COMPLETED" || "NOT_ELIGIBLE" || "ELIGIBLE",
// Description: "STRING_VALUE",
// AutomatedUpdateDate: new Date("TIMESTAMP"),
// OptionalDeployment: true || false,
// },
// DomainEndpointOptions: { // DomainEndpointOptions
// EnforceHTTPS: true || false,
// TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07" || "Policy-Min-TLS-1-2-PFS-2023-10",
// CustomEndpointEnabled: true || false,
// CustomEndpoint: "STRING_VALUE",
// CustomEndpointCertificateArn: "STRING_VALUE",
// },
// AdvancedSecurityOptions: { // AdvancedSecurityOptions
// Enabled: true || false,
// InternalUserDatabaseEnabled: true || false,
// SAMLOptions: { // SAMLOptionsOutput
// Enabled: true || false,
// Idp: { // SAMLIdp
// MetadataContent: "STRING_VALUE", // required
// EntityId: "STRING_VALUE", // required
// },
// SubjectKey: "STRING_VALUE",
// RolesKey: "STRING_VALUE",
// SessionTimeoutMinutes: Number("int"),
// },
// JWTOptions: { // JWTOptionsOutput
// Enabled: true || false,
// SubjectKey: "STRING_VALUE",
// RolesKey: "STRING_VALUE",
// PublicKey: "STRING_VALUE",
// },
// AnonymousAuthDisableDate: new Date("TIMESTAMP"),
// AnonymousAuthEnabled: true || false,
// },
// IdentityCenterOptions: { // IdentityCenterOptions
// EnabledAPIAccess: true || false,
// IdentityCenterInstanceARN: "STRING_VALUE",
// SubjectKey: "UserName" || "UserId" || "Email",
// RolesKey: "GroupName" || "GroupId",
// IdentityCenterApplicationARN: "STRING_VALUE",
// IdentityStoreId: "STRING_VALUE",
// },
// AutoTuneOptions: { // AutoTuneOptionsOutput
// State: "ENABLED" || "DISABLED" || "ENABLE_IN_PROGRESS" || "DISABLE_IN_PROGRESS" || "DISABLED_AND_ROLLBACK_SCHEDULED" || "DISABLED_AND_ROLLBACK_IN_PROGRESS" || "DISABLED_AND_ROLLBACK_COMPLETE" || "DISABLED_AND_ROLLBACK_ERROR" || "ERROR",
// ErrorMessage: "STRING_VALUE",
// UseOffPeakWindow: true || false,
// },
// ChangeProgressDetails: { // ChangeProgressDetails
// ChangeId: "STRING_VALUE",
// Message: "STRING_VALUE",
// ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
// InitiatedBy: "CUSTOMER" || "SERVICE",
// StartTime: new Date("TIMESTAMP"),
// LastUpdatedTime: new Date("TIMESTAMP"),
// },
// OffPeakWindowOptions: { // OffPeakWindowOptions
// Enabled: true || false,
// OffPeakWindow: { // OffPeakWindow
// WindowStartTime: { // WindowStartTime
// Hours: Number("long"), // required
// Minutes: Number("long"), // required
// },
// },
// },
// SoftwareUpdateOptions: { // SoftwareUpdateOptions
// AutoSoftwareUpdateEnabled: true || false,
// },
// DomainProcessingStatus: "Creating" || "Active" || "Modifying" || "UpgradingEngineVersion" || "UpdatingServiceSoftware" || "Isolated" || "Deleting",
// ModifyingProperties: [ // ModifyingPropertiesList
// { // ModifyingProperties
// Name: "STRING_VALUE",
// ActiveValue: "STRING_VALUE",
// PendingValue: "STRING_VALUE",
// ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
// },
// ],
// AIMLOptions: { // AIMLOptionsOutput
// NaturalLanguageQueryGenerationOptions: { // NaturalLanguageQueryGenerationOptionsOutput
// DesiredState: "ENABLED" || "DISABLED",
// CurrentState: "NOT_ENABLED" || "ENABLE_COMPLETE" || "ENABLE_IN_PROGRESS" || "ENABLE_FAILED" || "DISABLE_COMPLETE" || "DISABLE_IN_PROGRESS" || "DISABLE_FAILED",
// },
// },
// },
// };
CreateDomainCommand Input
See CreateDomainCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
DomainNameRequired | string | undefined | Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region. |
AIMLOptions | AIMLOptionsInput | undefined | Options for all machine learning features for the specified domain. |
AccessPolicies | string | undefined | Identity and Access Management (IAM) policy document specifying the access policies for the new domain. |
AdvancedOptions | Record<string, string> | undefined | Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
For more information, see Advanced cluster parameters . |
AdvancedSecurityOptions | AdvancedSecurityOptionsInput | undefined | Options for fine-grained access control. |
AutoTuneOptions | AutoTuneOptionsInput | undefined | Options for Auto-Tune. |
ClusterConfig | ClusterConfig | undefined | Container for the cluster configuration of a domain. |
CognitoOptions | CognitoOptions | undefined | Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards . |
DomainEndpointOptions | DomainEndpointOptions | undefined | Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. |
EBSOptions | EBSOptions | undefined | Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain. |
EncryptionAtRestOptions | EncryptionAtRestOptions | undefined | Key-value pairs to enable encryption at rest. |
EngineVersion | string | undefined | String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, |
IPAddressType | IPAddressType | undefined | 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. |
IdentityCenterOptions | IdentityCenterOptionsInput | undefined | Options for IAM Identity Center Option control for the domain. |
LogPublishingOptions | Partial<Record<LogType, LogPublishingOption> | undefined | Key-value pairs to configure log publishing. |
NodeToNodeEncryptionOptions | NodeToNodeEncryptionOptions | undefined | Enables node-to-node encryption. |
OffPeakWindowOptions | OffPeakWindowOptions | undefined | Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used. |
SnapshotOptions | SnapshotOptions | undefined | DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes. |
SoftwareUpdateOptions | SoftwareUpdateOptions | undefined | Software update options for the domain. |
TagList | Tag[] | undefined | List of tags to add to the domain upon creation. |
VPCOptions | VPCOptions | undefined | Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC . |
CreateDomainCommand Output
See CreateDomainCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
DomainStatus | DomainStatus | undefined | The status of the newly created domain. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| BaseException | client | An error occurred while processing the request. |
| DisabledOperationException | client | An error occured because the client wanted to access an unsupported operation. |
| InternalException | server | Request processing failed because of an unknown error, exception, or internal failure. |
| InvalidTypeException | client | An exception for trying to create or access a sub-resource that's either invalid or not supported. |
| LimitExceededException | client | An exception for trying to create more than the allowed number of resources or sub-resources. |
| ResourceAlreadyExistsException | client | An exception for creating a resource that already exists. |
| ValidationException | client | An exception for accessing or deleting a resource that doesn't exist. |
| OpenSearchServiceException | Base exception class for all service exceptions from OpenSearch service. |