AWS.Tools.Elasticsearch.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Elasticsearch</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.ES.AddESResourceTagCmdlet"> <summary> Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-awsresorcetagging" target="_blank"> Tagging Amazon Elasticsearch Service Domains for more information.</a> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.AddESResourceTagCmdlet.ARN"> <summary> <para> <para> Specify the <code>ARN</code> for which you want to add the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.AddESResourceTagCmdlet.TagList"> <summary> <para> <para> List of <code>Tag</code> that need to be added for the Elasticsearch domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.AddESResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.AddTagsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.AddESResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TagList parameter. The -PassThru parameter is deprecated, use -Select '^TagList' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.AddESResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESCompatibleElasticsearchVersionCmdlet"> <summary> Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a <code><a>DomainName</a></code> to get all upgrade compatible Elasticsearch versions for that specific domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESCompatibleElasticsearchVersionCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESCompatibleElasticsearchVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CompatibleElasticsearchVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.GetCompatibleElasticsearchVersionsResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.GetCompatibleElasticsearchVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESCompatibleElasticsearchVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESDomainCmdlet"> <summary> Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESDomainCmdlet.DomainName"> <summary> <para> <para>The name of the Elasticsearch domain for which you want information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESDomainCmdlet.Select"> <summary> 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.Elasticsearch.Model.DescribeElasticsearchDomainResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.DescribeElasticsearchDomainResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESDomainConfigCmdlet"> <summary> Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESDomainConfigCmdlet.DomainName"> <summary> <para> <para>The Elasticsearch domain that you want to get information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESDomainConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.DescribeElasticsearchDomainConfigResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.DescribeElasticsearchDomainConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESDomainConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESDomainListCmdlet"> <summary> Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESDomainListCmdlet.DomainName"> <summary> <para> <para>The Elasticsearch domains for which you want information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESDomainListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainStatusList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.DescribeElasticsearchDomainsResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.DescribeElasticsearchDomainsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESDomainListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESDomainNameListCmdlet"> <summary> Returns the name of all Elasticsearch domains owned by the current user's account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESDomainNameListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainNames'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.ListDomainNamesResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.ListDomainNamesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESInstanceTypeLimitCmdlet"> <summary> Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the <code><a>DomainName</a></code> to know what Limits are supported for modifying. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESInstanceTypeLimitCmdlet.DomainName"> <summary> <para> <para> DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch <code><a>Limits</a></code> for existing domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESInstanceTypeLimitCmdlet.ElasticsearchVersion"> <summary> <para> <para> Version of Elasticsearch for which <code><a>Limits</a></code> are needed. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESInstanceTypeLimitCmdlet.InstanceType"> <summary> <para> <para> The instance type for an Elasticsearch cluster for which Elasticsearch <code><a>Limits</a></code> are needed. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESInstanceTypeLimitCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LimitsByRole'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.DescribeElasticsearchInstanceTypeLimitsResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.DescribeElasticsearchInstanceTypeLimitsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESInstanceTypeLimitCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESInstanceTypeListCmdlet"> <summary> List all Elasticsearch instance types that are supported for given ElasticsearchVersion<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESInstanceTypeListCmdlet.DomainName"> <summary> <para> <para>DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESInstanceTypeListCmdlet.ElasticsearchVersion"> <summary> <para> <para>Version of Elasticsearch for which list of supported elasticsearch instance types are needed. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESInstanceTypeListCmdlet.MaxResult"> <summary> <para> <para> Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESInstanceTypeListCmdlet.NextToken"> <summary> <para> <para>NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESInstanceTypeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ElasticsearchInstanceTypes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.ListElasticsearchInstanceTypesResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.ListElasticsearchInstanceTypesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESInstanceTypeListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESInstanceTypeListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESReservedElasticsearchInstanceListCmdlet"> <summary> Returns information about reserved Elasticsearch instances for this account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESReservedElasticsearchInstanceListCmdlet.ReservedElasticsearchInstanceId"> <summary> <para> <para>The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESReservedElasticsearchInstanceListCmdlet.MaxResult"> <summary> <para> <para>Set this value to limit the number of results returned. If not specified, defaults to 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESReservedElasticsearchInstanceListCmdlet.NextToken"> <summary> <para> <para>NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESReservedElasticsearchInstanceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReservedElasticsearchInstances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.DescribeReservedElasticsearchInstancesResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.DescribeReservedElasticsearchInstancesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESReservedElasticsearchInstanceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReservedElasticsearchInstanceId parameter. The -PassThru parameter is deprecated, use -Select '^ReservedElasticsearchInstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESReservedElasticsearchInstanceListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESReservedElasticsearchInstanceOfferingListCmdlet"> <summary> Lists available reserved Elasticsearch instance offerings.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESReservedElasticsearchInstanceOfferingListCmdlet.ReservedElasticsearchInstanceOfferingId"> <summary> <para> <para>The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESReservedElasticsearchInstanceOfferingListCmdlet.MaxResult"> <summary> <para> <para>Set this value to limit the number of results returned. If not specified, defaults to 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESReservedElasticsearchInstanceOfferingListCmdlet.NextToken"> <summary> <para> <para>NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESReservedElasticsearchInstanceOfferingListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReservedElasticsearchInstanceOfferings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.DescribeReservedElasticsearchInstanceOfferingsResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.DescribeReservedElasticsearchInstanceOfferingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESReservedElasticsearchInstanceOfferingListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReservedElasticsearchInstanceOfferingId parameter. The -PassThru parameter is deprecated, use -Select '^ReservedElasticsearchInstanceOfferingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESReservedElasticsearchInstanceOfferingListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESResourceTagCmdlet"> <summary> Returns all tags for the given Elasticsearch domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESResourceTagCmdlet.ARN"> <summary> <para> <para> Specify the <code>ARN</code> for the Elasticsearch domain to which the tags are attached that you want to view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TagList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.ListTagsResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.ListTagsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ARN parameter. The -PassThru parameter is deprecated, use -Select '^ARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESUpgradeHistoryCmdlet"> <summary> Retrieves the complete history of the last 10 upgrades that were performed on the domain.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESUpgradeHistoryCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESUpgradeHistoryCmdlet.MaxResult"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESUpgradeHistoryCmdlet.NextToken"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESUpgradeHistoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UpgradeHistories'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.GetUpgradeHistoryResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.GetUpgradeHistoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESUpgradeHistoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESUpgradeHistoryCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESUpgradeStatusCmdlet"> <summary> Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESUpgradeStatusCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESUpgradeStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.GetUpgradeStatusResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.GetUpgradeStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESUpgradeStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESVersionListCmdlet"> <summary> List all supported Elasticsearch versions<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESVersionListCmdlet.MaxResult"> <summary> <para> <para> Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be honored. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESVersionListCmdlet.NextToken"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ElasticsearchVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.ListElasticsearchVersionsResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.ListElasticsearchVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESVersionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet"> <summary> Creates a new Elasticsearch domain. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains" target="_blank">Creating Elasticsearch Domains</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.AccessPolicy"> <summary> <para> <para> IAM access policy as a JSON-formatted string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.AdvancedOption"> <summary> <para> <para> Option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options" target="_blank">Configuration Advanced Options</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.SnapshotOptions_AutomatedSnapshotStartHour"> <summary> <para> <para>Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is <code>0</code> hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ZoneAwarenessConfig_AvailabilityZoneCount"> <summary> <para> <para>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</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_DedicatedMasterCount"> <summary> <para> <para>Total number of dedicated master nodes, active and on standby, for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_DedicatedMasterEnabled"> <summary> <para> <para>A boolean value to indicate whether a dedicated master node is enabled. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes" target="_blank">About Dedicated Master Nodes</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_DedicatedMasterType"> <summary> <para> <para>The instance type for a dedicated master node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.DomainName"> <summary> <para> <para>The name of the Elasticsearch domain that you are 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).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.EBSOptions_EBSEnabled"> <summary> <para> <para>Specifies whether EBS-based storage is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchVersion"> <summary> <para> <para>String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains" target="_blank">Creating Elasticsearch Domains</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.CognitoOptions_Enabled"> <summary> <para> <para>Specifies the option to enable Cognito for Kibana authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.NodeToNodeEncryptionOptions_Enabled"> <summary> <para> <para>Specify true to enable node-to-node encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.EncryptionAtRestOption"> <summary> <para> <para>Specifies the Encryption At Rest Options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.DomainEndpointOptions_EnforceHTTPS"> <summary> <para> <para>Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.CognitoOptions_IdentityPoolId"> <summary> <para> <para>Specifies the Cognito identity pool ID for Kibana authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_InstanceCount"> <summary> <para> <para>The number of instances in the specified domain cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_InstanceType"> <summary> <para> <para>The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.EBSOptions_Iops"> <summary> <para> <para>Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.LogPublishingOption"> <summary> <para> <para>Map of <code>LogType</code> and <code>LogPublishingOption</code>, each containing options to publish a given type of Elasticsearch log.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.CognitoOptions_RoleArn"> <summary> <para> <para>Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.VPCOptions_SecurityGroupId"> <summary> <para> <para>Specifies the security groups for VPC endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.VPCOptions_SubnetId"> <summary> <para> <para>Specifies the subnets for VPC endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.DomainEndpointOptions_TLSSecurityPolicy"> <summary> <para> <para>Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. <br /> It can be one of the following values: <ul><li><b>Policy-Min-TLS-1-0-2019-07: </b> TLS security policy which supports TLSv1.0 and higher.</li><li><b>Policy-Min-TLS-1-2-2019-07: </b> TLS security policy which supports only TLSv1.2</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.CognitoOptions_UserPoolId"> <summary> <para> <para>Specifies the Cognito user pool ID for Kibana authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.EBSOptions_VolumeSize"> <summary> <para> <para> Integer to specify the size of an EBS volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.EBSOptions_VolumeType"> <summary> <para> <para> Specifies the volume type for EBS-based storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_WarmCount"> <summary> <para> <para>The number of warm nodes in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_WarmEnabled"> <summary> <para> <para>True to enable warm storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_WarmType"> <summary> <para> <para>The instance type for the Elasticsearch cluster's warm nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_ZoneAwarenessEnabled"> <summary> <para> <para>A boolean value to indicate whether zone awareness is enabled. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness" target="_blank">About Zone Awareness</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.Select"> <summary> 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.Elasticsearch.Model.CreateElasticsearchDomainResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.CreateElasticsearchDomainResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.NewESReservedElasticsearchInstanceOfferingCmdlet"> <summary> Allows you to purchase reserved Elasticsearch instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESReservedElasticsearchInstanceOfferingCmdlet.InstanceCount"> <summary> <para> <para>The number of Elasticsearch instances to reserve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESReservedElasticsearchInstanceOfferingCmdlet.ReservationName"> <summary> <para> <para>A customer-specified identifier to track this reservation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESReservedElasticsearchInstanceOfferingCmdlet.ReservedElasticsearchInstanceOfferingId"> <summary> <para> <para>The ID of the reserved Elasticsearch instance offering to purchase.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESReservedElasticsearchInstanceOfferingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.PurchaseReservedElasticsearchInstanceOfferingResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.PurchaseReservedElasticsearchInstanceOfferingResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESReservedElasticsearchInstanceOfferingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReservedElasticsearchInstanceOfferingId parameter. The -PassThru parameter is deprecated, use -Select '^ReservedElasticsearchInstanceOfferingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESReservedElasticsearchInstanceOfferingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.RemoveESDomainCmdlet"> <summary> Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESDomainCmdlet.DomainName"> <summary> <para> <para>The name of the Elasticsearch domain that you want to permanently delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESDomainCmdlet.Select"> <summary> 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.Elasticsearch.Model.DeleteElasticsearchDomainResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.DeleteElasticsearchDomainResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESDomainCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.RemoveESElasticsearchServiceRoleCmdlet"> <summary> Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-enabling-slr" target="_blank">Deleting Elasticsearch Service Role</a> in <i>VPC Endpoints for Amazon Elasticsearch Service Domains</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESElasticsearchServiceRoleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.DeleteElasticsearchServiceRoleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESElasticsearchServiceRoleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.RemoveESResourceTagCmdlet"> <summary> Removes the specified set of tags from the specified Elasticsearch domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESResourceTagCmdlet.ARN"> <summary> <para> <para>Specifies the <code>ARN</code> for the Elasticsearch domain from which you want to delete the specified tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESResourceTagCmdlet.TagKey"> <summary> <para> <para>Specifies the <code>TagKey</code> list which you want to remove from the Elasticsearch domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.RemoveTagsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TagKey parameter. The -PassThru parameter is deprecated, use -Select '^TagKey' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.StartESElasticsearchServiceSoftwareUpdateCmdlet"> <summary> Schedules a service software update for an Amazon ES domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.StartESElasticsearchServiceSoftwareUpdateCmdlet.DomainName"> <summary> <para> <para>The name of the domain that you want to update to the latest service software.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.StartESElasticsearchServiceSoftwareUpdateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceSoftwareOptions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.StartElasticsearchServiceSoftwareUpdateResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.StartElasticsearchServiceSoftwareUpdateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.StartESElasticsearchServiceSoftwareUpdateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.StartESElasticsearchServiceSoftwareUpdateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.StopESElasticsearchServiceSoftwareUpdateCmdlet"> <summary> Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the <code>AutomatedUpdateDate</code> and when the <code>UpdateStatus</code> is in the <code>PENDING_UPDATE</code> state. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.StopESElasticsearchServiceSoftwareUpdateCmdlet.DomainName"> <summary> <para> <para>The name of the domain that you want to stop the latest service software update on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.StopESElasticsearchServiceSoftwareUpdateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceSoftwareOptions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.CancelElasticsearchServiceSoftwareUpdateResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.CancelElasticsearchServiceSoftwareUpdateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.StopESElasticsearchServiceSoftwareUpdateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.StopESElasticsearchServiceSoftwareUpdateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet"> <summary> Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.AccessPolicy"> <summary> <para> <para>IAM access policy as a JSON-formatted string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.AdvancedOption"> <summary> <para> <para>Modifies the advanced option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options" target="_blank">Configuration Advanced Options</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.SnapshotOptions_AutomatedSnapshotStartHour"> <summary> <para> <para>Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is <code>0</code> hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ZoneAwarenessConfig_AvailabilityZoneCount"> <summary> <para> <para>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</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_DedicatedMasterCount"> <summary> <para> <para>Total number of dedicated master nodes, active and on standby, for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_DedicatedMasterEnabled"> <summary> <para> <para>A boolean value to indicate whether a dedicated master node is enabled. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes" target="_blank">About Dedicated Master Nodes</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_DedicatedMasterType"> <summary> <para> <para>The instance type for a dedicated master node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.DomainName"> <summary> <para> <para>The name of the Elasticsearch domain that you are updating. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.EBSOptions_EBSEnabled"> <summary> <para> <para>Specifies whether EBS-based storage is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.CognitoOptions_Enabled"> <summary> <para> <para>Specifies the option to enable Cognito for Kibana authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.DomainEndpointOptions_EnforceHTTPS"> <summary> <para> <para>Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.CognitoOptions_IdentityPoolId"> <summary> <para> <para>Specifies the Cognito identity pool ID for Kibana authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_InstanceCount"> <summary> <para> <para>The number of instances in the specified domain cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_InstanceType"> <summary> <para> <para>The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.EBSOptions_Iops"> <summary> <para> <para>Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.LogPublishingOption"> <summary> <para> <para>Map of <code>LogType</code> and <code>LogPublishingOption</code>, each containing options to publish a given type of Elasticsearch log.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.CognitoOptions_RoleArn"> <summary> <para> <para>Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.VPCOptions_SecurityGroupId"> <summary> <para> <para>Specifies the security groups for VPC endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.VPCOptions_SubnetId"> <summary> <para> <para>Specifies the subnets for VPC endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.DomainEndpointOptions_TLSSecurityPolicy"> <summary> <para> <para>Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. <br /> It can be one of the following values: <ul><li><b>Policy-Min-TLS-1-0-2019-07: </b> TLS security policy which supports TLSv1.0 and higher.</li><li><b>Policy-Min-TLS-1-2-2019-07: </b> TLS security policy which supports only TLSv1.2</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.CognitoOptions_UserPoolId"> <summary> <para> <para>Specifies the Cognito user pool ID for Kibana authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.EBSOptions_VolumeSize"> <summary> <para> <para> Integer to specify the size of an EBS volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.EBSOptions_VolumeType"> <summary> <para> <para> Specifies the volume type for EBS-based storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_WarmCount"> <summary> <para> <para>The number of warm nodes in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_WarmEnabled"> <summary> <para> <para>True to enable warm storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_WarmType"> <summary> <para> <para>The instance type for the Elasticsearch cluster's warm nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_ZoneAwarenessEnabled"> <summary> <para> <para>A boolean value to indicate whether zone awareness is enabled. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness" target="_blank">About Zone Awareness</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.UpdateElasticsearchDomainConfigResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.UpdateElasticsearchDomainConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.UpdateESElasticsearchDomainCmdlet"> <summary> Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESElasticsearchDomainCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESElasticsearchDomainCmdlet.PerformCheckOnly"> <summary> <para> <para> This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESElasticsearchDomainCmdlet.TargetVersion"> <summary> <para> <para>The version of Elasticsearch that you intend to upgrade the domain to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESElasticsearchDomainCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Elasticsearch.Model.UpgradeElasticsearchDomainResponse). Specifying the name of a property of type Amazon.Elasticsearch.Model.UpgradeElasticsearchDomainResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESElasticsearchDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TargetVersion parameter. The -PassThru parameter is deprecated, use -Select '^TargetVersion' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESElasticsearchDomainCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |