AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon OpenSearch Service CreateDomain API operation.

Syntax

New-OSDomain
-AccessPolicy <String>
-AdvancedOption <Hashtable>
-AdvancedSecurityOptions_AnonymousAuthEnabled <Boolean>
-SnapshotOptions_AutomatedSnapshotStartHour <Int32>
-ZoneAwarenessConfig_AvailabilityZoneCount <Int32>
-DomainEndpointOptions_CustomEndpoint <String>
-DomainEndpointOptions_CustomEndpointCertificateArn <String>
-DomainEndpointOptions_CustomEndpointEnabled <Boolean>
-ClusterConfig_DedicatedMasterCount <Int32>
-ClusterConfig_DedicatedMasterEnabled <Boolean>
-ClusterConfig_DedicatedMasterType <OpenSearchPartitionInstanceType>
-AutoTuneOptions_DesiredState <AutoTuneDesiredState>
-DomainName <String>
-EBSOptions_EBSEnabled <Boolean>
-AdvancedSecurityOptions_Enabled <Boolean>
-SAMLOptions_Enabled <Boolean>
-ColdStorageOptions_Enabled <Boolean>
-CognitoOptions_Enabled <Boolean>
-EncryptionAtRestOptions_Enabled <Boolean>
-NodeToNodeEncryptionOptions_Enabled <Boolean>
-DomainEndpointOptions_EnforceHTTPS <Boolean>
-EngineVersion <String>
-Idp_EntityId <String>
-CognitoOptions_IdentityPoolId <String>
-ClusterConfig_InstanceCount <Int32>
-ClusterConfig_InstanceType <OpenSearchPartitionInstanceType>
-AdvancedSecurityOptions_InternalUserDatabaseEnabled <Boolean>
-EBSOptions_Iops <Int32>
-EncryptionAtRestOptions_KmsKeyId <String>
-LogPublishingOption <Hashtable>
-AutoTuneOptions_MaintenanceSchedule <AutoTuneMaintenanceSchedule[]>
-SAMLOptions_MasterBackendRole <String>
-MasterUserOptions_MasterUserARN <String>
-MasterUserOptions_MasterUserName <String>
-SAMLOptions_MasterUserName <String>
-MasterUserOptions_MasterUserPassword <String>
-Idp_MetadataContent <String>
-CognitoOptions_RoleArn <String>
-SAMLOptions_RolesKey <String>
-VPCOptions_SecurityGroupId <String[]>
-SAMLOptions_SessionTimeoutMinute <Int32>
-SAMLOptions_SubjectKey <String>
-VPCOptions_SubnetId <String[]>
-TagList <Tag[]>
-DomainEndpointOptions_TLSSecurityPolicy <TLSSecurityPolicy>
-CognitoOptions_UserPoolId <String>
-EBSOptions_VolumeSize <Int32>
-EBSOptions_VolumeType <VolumeType>
-ClusterConfig_WarmCount <Int32>
-ClusterConfig_WarmEnabled <Boolean>
-ClusterConfig_WarmType <OpenSearchWarmPartitionInstanceType>
-ClusterConfig_ZoneAwarenessEnabled <Boolean>
-Select <String>
-Force <SwitchParameter>

Description

Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide.

Parameters

-AccessPolicy <String>
IAM access policy as a JSON-formatted string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccessPolicies
-AdvancedOption <Hashtable>
Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdvancedOptions
-AdvancedSecurityOptions_AnonymousAuthEnabled <Boolean>
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AdvancedSecurityOptions_Enabled <Boolean>
True if advanced security is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AdvancedSecurityOptions_InternalUserDatabaseEnabled <Boolean>
True if the internal user database is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoTuneOptions_DesiredState <AutoTuneDesiredState>
The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoTuneOptions_MaintenanceSchedule <AutoTuneMaintenanceSchedule[]>
A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoTuneOptions_MaintenanceSchedules
-ClusterConfig_DedicatedMasterCount <Int32>
Total number of dedicated master nodes, active and on standby, for the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterConfig_DedicatedMasterEnabled <Boolean>
A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterConfig_DedicatedMasterType <OpenSearchPartitionInstanceType>
The instance type for a dedicated master node.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterConfig_InstanceCount <Int32>
The number of instances in the specified domain cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterConfig_InstanceType <OpenSearchPartitionInstanceType>
The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterConfig_WarmCount <Int32>
The number of UltraWarm nodes in the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterConfig_WarmEnabled <Boolean>
True to enable UltraWarm storage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterConfig_WarmType <OpenSearchWarmPartitionInstanceType>
The instance type for the OpenSearch cluster's warm nodes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterConfig_ZoneAwarenessEnabled <Boolean>
A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CognitoOptions_Enabled <Boolean>
The option to enable Cognito for OpenSearch Dashboards authentication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CognitoOptions_IdentityPoolId <String>
The Cognito identity pool ID for OpenSearch Dashboards authentication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CognitoOptions_RoleArn <String>
The role ARN that provides OpenSearch permissions for accessing Cognito resources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CognitoOptions_UserPoolId <String>
The Cognito user pool ID for OpenSearch Dashboards authentication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ColdStorageOptions_Enabled <Boolean>
Enable cold storage option. Accepted values true or false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesClusterConfig_ColdStorageOptions_Enabled
-DomainEndpointOptions_CustomEndpoint <String>
The fully qualified domain for your custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainEndpointOptions_CustomEndpointCertificateArn <String>
The ACM certificate ARN for your custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainEndpointOptions_CustomEndpointEnabled <Boolean>
Whether to enable a custom endpoint for the domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainEndpointOptions_EnforceHTTPS <Boolean>
Whether only HTTPS endpoint should be enabled for the domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainEndpointOptions_TLSSecurityPolicy <TLSSecurityPolicy>
Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:
  • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
  • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainName <String>
The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EBSOptions_EBSEnabled <Boolean>
Whether EBS-based storage is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EBSOptions_Iops <Int32>
The IOPD for a Provisioned IOPS EBS volume (SSD).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EBSOptions_VolumeSize <Int32>
Integer to specify the size of an EBS volume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EBSOptions_VolumeType <VolumeType>
The volume type for EBS-based storage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionAtRestOptions_Enabled <Boolean>
The option to enable encryption at rest.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionAtRestOptions_KmsKeyId <String>
The KMS key ID for encryption at rest options.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see Creating and managing Amazon OpenSearch Service domains .
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Idp_EntityId <String>
The unique entity ID of the application in SAML identity provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdvancedSecurityOptions_SAMLOptions_Idp_EntityId
-Idp_MetadataContent <String>
The metadata of the SAML application in XML format.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdvancedSecurityOptions_SAMLOptions_Idp_MetadataContent
-LogPublishingOption <Hashtable>
Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogPublishingOptions
-MasterUserOptions_MasterUserARN <String>
ARN for the master user (if IAM is enabled).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdvancedSecurityOptions_MasterUserOptions_MasterUserARN
-MasterUserOptions_MasterUserName <String>
The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdvancedSecurityOptions_MasterUserOptions_MasterUserName
-MasterUserOptions_MasterUserPassword <String>
The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdvancedSecurityOptions_MasterUserOptions_MasterUserPassword
-NodeToNodeEncryptionOptions_Enabled <Boolean>
True to enable node-to-node encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SAMLOptions_Enabled <Boolean>
True if SAML is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdvancedSecurityOptions_SAMLOptions_Enabled
-SAMLOptions_MasterBackendRole <String>
The backend role that the SAML master user is mapped to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdvancedSecurityOptions_SAMLOptions_MasterBackendRole
-SAMLOptions_MasterUserName <String>
The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdvancedSecurityOptions_SAMLOptions_MasterUserName
-SAMLOptions_RolesKey <String>
Element of the SAML assertion to use for backend roles. Default is roles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdvancedSecurityOptions_SAMLOptions_RolesKey
-SAMLOptions_SessionTimeoutMinute <Int32>
The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdvancedSecurityOptions_SAMLOptions_SessionTimeoutMinutes
-SAMLOptions_SubjectKey <String>
Element of the SAML assertion to use for username. Default is NameID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdvancedSecurityOptions_SAMLOptions_SubjectKey
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'DomainStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.CreateDomainResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.CreateDomainResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnapshotOptions_AutomatedSnapshotStartHour <Int32>
The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TagList <Tag[]>
A list of Tag added during domain creation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VPCOptions_SecurityGroupId <String[]>
The security groups for the VPC endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVPCOptions_SecurityGroupIds
-VPCOptions_SubnetId <String[]>
The subnets for the VPC endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVPCOptions_SubnetIds
-ZoneAwarenessConfig_AvailabilityZoneCount <Int32>
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesClusterConfig_ZoneAwarenessConfig_AvailabilityZoneCount

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.OpenSearchService.Model.DomainStatus object. The service call response (type Amazon.OpenSearchService.Model.CreateDomainResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z