Synopsis
Calls the Amazon Elasticsearch UpdateElasticsearchDomainConfig API operation.
Syntax
Update-ESDomainConfig-AccessPolicy <String>-AdvancedOption <Hashtable>-SnapshotOptions_AutomatedSnapshotStartHour <Int32>-ZoneAwarenessConfig_AvailabilityZoneCount <Int32>-ElasticsearchClusterConfig_DedicatedMasterCount <Int32>-ElasticsearchClusterConfig_DedicatedMasterEnabled <Boolean>-ElasticsearchClusterConfig_DedicatedMasterType <ESPartitionInstanceType>-DomainName <String>-EBSOptions_EBSEnabled <Boolean>-CognitoOptions_Enabled <Boolean>-CognitoOptions_IdentityPoolId <String>-ElasticsearchClusterConfig_InstanceCount <Int32>-ElasticsearchClusterConfig_InstanceType <ESPartitionInstanceType>-EBSOptions_Iops <Int32>-LogPublishingOption <Hashtable>-CognitoOptions_RoleArn <String>-VPCOptions_SecurityGroupId <String[]>-VPCOptions_SubnetId <String[]>-CognitoOptions_UserPoolId <String>-EBSOptions_VolumeSize <Int32>-EBSOptions_VolumeType <VolumeType>-ElasticsearchClusterConfig_ZoneAwarenessEnabled <Boolean>-Force <SwitchParameter>
Description
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
Parameters
-AccessPolicy <String>
IAM access policy as a JSON-formatted string.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | AccessPolicies |
-AdvancedOption <Hashtable>
Modifies the advanced 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 Configuration Advanced Options for more information. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | AdvancedOptions |
-CognitoOptions_Enabled <Boolean>
Specifies the option to enable Cognito for Kibana authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-CognitoOptions_IdentityPoolId <String>
Specifies the Cognito identity pool ID for Kibana authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-CognitoOptions_RoleArn <String>
Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-CognitoOptions_UserPoolId <String>
Specifies the Cognito user pool ID for Kibana authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-DomainName <String>
The name of the Elasticsearch domain that you are updating.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EBSOptions_EBSEnabled <Boolean>
Specifies whether EBS-based storage is enabled.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EBSOptions_Iops <Int32>
Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EBSOptions_VolumeSize <Int32>
Integer to specify the size of an EBS volume.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EBSOptions_VolumeType <VolumeType>
Specifies the volume type for EBS-based storage.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ElasticsearchClusterConfig_DedicatedMasterCount <Int32>
Total number of dedicated master nodes, active and on standby, for the cluster.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ElasticsearchClusterConfig_DedicatedMasterEnabled <Boolean>
A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ElasticsearchClusterConfig_DedicatedMasterType <ESPartitionInstanceType>
The instance type for a dedicated master node.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ElasticsearchClusterConfig_InstanceCount <Int32>
The number of instances in the specified domain cluster.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ElasticsearchClusterConfig_InstanceType <ESPartitionInstanceType>
The instance type for an Elasticsearch cluster.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ElasticsearchClusterConfig_ZoneAwarenessEnabled <Boolean>
A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Force <SwitchParameter>
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? | False |
-LogPublishingOption <Hashtable>
Map of
LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | LogPublishingOptions |
-SnapshotOptions_AutomatedSnapshotStartHour <Int32>
Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is
0 hours. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-VPCOptions_SecurityGroupId <String[]>
Specifies the security groups for VPC endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | VPCOptions_SecurityGroupIds |
-VPCOptions_SubnetId <String[]>
Specifies the subnets for VPC endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | VPCOptions_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? | False |
| Aliases | ElasticsearchClusterConfig_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? | False |
-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? | False |
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
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? | False |
-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? | False |
-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? | False |
-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? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
Inputs
This cmdlet does not accept pipeline input.
Outputs
This cmdlet returns a Amazon.Elasticsearch.Model.ElasticsearchDomainConfig object.
The service call response (type Amazon.Elasticsearch.Model.UpdateElasticsearchDomainConfigResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
