AWS.Tools.OpenSearchService.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.OpenSearchService</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.OS.AddOSDataSourceCmdlet"> <summary> Creates a new direct-query data source to the specified domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html">Creating Amazon OpenSearch Service data source integrations with Amazon S3</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.AddOSDataSourceCmdlet.Description"> <summary> <para> <para>A description of the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.AddOSDataSourceCmdlet.DomainName"> <summary> <para> <para>The name of the domain to add the data source to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.AddOSDataSourceCmdlet.Name"> <summary> <para> <para>A name for the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.AddOSDataSourceCmdlet.S3GlueDataCatalog_RoleArn"> <summary> <para> <para>>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.AddOSDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Message'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.AddDataSourceResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.AddDataSourceResponse 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.OS.AddOSDataSourceCmdlet.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.OS.AddOSResourceTagCmdlet"> <summary> Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html">Tagging Amazon OpenSearch Service domains</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.AddOSResourceTagCmdlet.ARN"> <summary> <para> <para>Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.AddOSResourceTagCmdlet.TagList"> <summary> <para> <para>List of resource tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.AddOSResourceTagCmdlet.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.OpenSearchService.Model.AddTagsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.AddOSResourceTagCmdlet.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.OS.ApproveOSInboundConnectionCmdlet"> <summary> Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.ApproveOSInboundConnectionCmdlet.ConnectionId"> <summary> <para> <para>The ID of the inbound connection to accept.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.ApproveOSInboundConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Connection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.AcceptInboundConnectionResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.AcceptInboundConnectionResponse 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.OS.ApproveOSInboundConnectionCmdlet.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.OS.ApproveOSVpcEndpointAccessCmdlet"> <summary> Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.ApproveOSVpcEndpointAccessCmdlet.Account"> <summary> <para> <para>The Amazon Web Services account ID to grant access to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.ApproveOSVpcEndpointAccessCmdlet.DomainName"> <summary> <para> <para>The name of the OpenSearch Service domain to provide access to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.ApproveOSVpcEndpointAccessCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AuthorizedPrincipal'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.AuthorizeVpcEndpointAccessResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.AuthorizeVpcEndpointAccessResponse 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.OS.ApproveOSVpcEndpointAccessCmdlet.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.OS.DenyOSInboundConnectionCmdlet"> <summary> Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.DenyOSInboundConnectionCmdlet.ConnectionId"> <summary> <para> <para>The unique identifier of the inbound connection to reject.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.DenyOSInboundConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Connection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.RejectInboundConnectionResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.RejectInboundConnectionResponse 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.OS.DenyOSInboundConnectionCmdlet.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.OS.GetOSCompatibleVersionCmdlet"> <summary> Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSCompatibleVersionCmdlet.DomainName"> <summary> <para> <para>The name of an existing domain. Provide this parameter to limit the results to a single domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSCompatibleVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CompatibleVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.GetCompatibleVersionsResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.GetCompatibleVersionsResponse 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.OS.GetOSDataSourceCmdlet"> <summary> Retrieves information about a direct query data source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDataSourceCmdlet.DomainName"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDataSourceCmdlet.Name"> <summary> <para> <para>The name of the data source to get information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDataSourceCmdlet.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.OpenSearchService.Model.GetDataSourceResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.GetDataSourceResponse 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.OS.GetOSDataSourceListCmdlet"> <summary> Lists direct-query data sources for a specific domain. For more information, see For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3.html">Working with Amazon OpenSearch Service direct queries with Amazon S3</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDataSourceListCmdlet.DomainName"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDataSourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSources'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.ListDataSourcesResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.ListDataSourcesResponse 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.OS.GetOSDomainCmdlet"> <summary> Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainCmdlet.DomainName"> <summary> <para> <para>The name of the domain that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainCmdlet.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.OpenSearchService.Model.DescribeDomainResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribeDomainResponse 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.OS.GetOSDomainAutoTuneCmdlet"> <summary> Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for Amazon OpenSearch Service</a>.<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.OS.GetOSDomainAutoTuneCmdlet.DomainName"> <summary> <para> <para>Name of the domain that you want Auto-Tune details about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainAutoTuneCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainAutoTuneCmdlet.NextToken"> <summary> <para> <para>If your initial <c>DescribeDomainAutoTunes</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>DescribeDomainAutoTunes</c> operations, which returns results in the next page.</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.OS.GetOSDomainAutoTuneCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutoTunes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.DescribeDomainAutoTunesResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribeDomainAutoTunesResponse 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.OS.GetOSDomainAutoTuneCmdlet.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.OS.GetOSDomainChangeProgressCmdlet"> <summary> Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes.html">Making configuration changes in Amazon OpenSearch Service</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainChangeProgressCmdlet.ChangeId"> <summary> <para> <para>The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainChangeProgressCmdlet.DomainName"> <summary> <para> <para>The name of the domain to get progress information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainChangeProgressCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChangeProgressStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.DescribeDomainChangeProgressResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribeDomainChangeProgressResponse 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.OS.GetOSDomainConfigCmdlet"> <summary> Returns the configuration of an Amazon OpenSearch Service domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainConfigCmdlet.DomainName"> <summary> <para> <para>Name of the OpenSearch Service domain configuration that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainConfigCmdlet.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.OpenSearchService.Model.DescribeDomainConfigResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribeDomainConfigResponse 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.OS.GetOSDomainHealthCmdlet"> <summary> Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainHealthCmdlet.DomainName"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainHealthCmdlet.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.OpenSearchService.Model.DescribeDomainHealthResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribeDomainHealthResponse 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.OS.GetOSDomainListCmdlet"> <summary> Returns domain configuration information about the specified Amazon OpenSearch Service domains. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainListCmdlet.DomainName"> <summary> <para> <para>Array of OpenSearch Service domain names that you want information about. You must specify at least one domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainListCmdlet.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.OpenSearchService.Model.DescribeDomainsResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribeDomainsResponse 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.OS.GetOSDomainMaintenanceListCmdlet"> <summary> A list of maintenance actions for 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.OS.GetOSDomainMaintenanceListCmdlet.Action"> <summary> <para> <para>The name of the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainMaintenanceListCmdlet.DomainName"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainMaintenanceListCmdlet.Status"> <summary> <para> <para>The status of the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainMaintenanceListCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainMaintenanceListCmdlet.NextToken"> <summary> <para> <para>If your initial <c>ListDomainMaintenances</c> operation returns a <c>nextToken</c>, include the returned <c>nextToken</c> in subsequent <c>ListDomainMaintenances</c> operations, which returns results in the next page.</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.OS.GetOSDomainMaintenanceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainMaintenances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.ListDomainMaintenancesResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.ListDomainMaintenancesResponse 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.OS.GetOSDomainMaintenanceListCmdlet.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.OS.GetOSDomainMaintenanceStatusCmdlet"> <summary> The status of the maintenance action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainMaintenanceStatusCmdlet.DomainName"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainMaintenanceStatusCmdlet.MaintenanceId"> <summary> <para> <para>The request ID of the maintenance action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainMaintenanceStatusCmdlet.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.OpenSearchService.Model.GetDomainMaintenanceStatusResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.GetDomainMaintenanceStatusResponse 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.OS.GetOSDomainNameListCmdlet"> <summary> Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainNameListCmdlet.EngineType"> <summary> <para> <para>Filters the output by domain engine type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainNameListCmdlet.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.OpenSearchService.Model.ListDomainNamesResponse). Specifying the name of a property of type Amazon.OpenSearchService.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.OS.GetOSDomainNodeCmdlet"> <summary> Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainNodeCmdlet.DomainName"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainNodeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainNodesStatusList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.DescribeDomainNodesResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribeDomainNodesResponse 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.OS.GetOSDomainsForPackageListCmdlet"> <summary> Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages for Amazon OpenSearch Service</a>.<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.OS.GetOSDomainsForPackageListCmdlet.PackageID"> <summary> <para> <para>The unique identifier of the package for which to list associated domains.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainsForPackageListCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainsForPackageListCmdlet.NextToken"> <summary> <para> <para>If your initial <c>ListDomainsForPackage</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>ListDomainsForPackage</c> operations, which returns results in the next page.</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.OS.GetOSDomainsForPackageListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainPackageDetailsList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.ListDomainsForPackageResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.ListDomainsForPackageResponse 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.OS.GetOSDomainsForPackageListCmdlet.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.OS.GetOSDryRunProgressCmdlet"> <summary> Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#dryrun">Determining whether a change will cause a blue/green deployment</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDryRunProgressCmdlet.DomainName"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDryRunProgressCmdlet.DryRunId"> <summary> <para> <para>The unique identifier of the dry run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDryRunProgressCmdlet.LoadDryRunConfig"> <summary> <para> <para>Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you're planning to make on the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDryRunProgressCmdlet.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.OpenSearchService.Model.DescribeDryRunProgressResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribeDryRunProgressResponse 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.OS.GetOSInboundConnectionCmdlet"> <summary> Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>.<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.OS.GetOSInboundConnectionCmdlet.Filter"> <summary> <para> <para> A list of filters used to match properties for inbound cross-cluster connections.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInboundConnectionCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInboundConnectionCmdlet.NextToken"> <summary> <para> <para>If your initial <c>DescribeInboundConnections</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>DescribeInboundConnections</c> operations, which returns results in the next page.</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.OS.GetOSInboundConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Connections'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.DescribeInboundConnectionsResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribeInboundConnectionsResponse 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.OS.GetOSInboundConnectionCmdlet.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.OS.GetOSInstanceTypeDetailListCmdlet"> <summary> Lists all instance types and available features for a given OpenSearch or Elasticsearch version.<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.OS.GetOSInstanceTypeDetailListCmdlet.DomainName"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInstanceTypeDetailListCmdlet.EngineVersion"> <summary> <para> <para>The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInstanceTypeDetailListCmdlet.InstanceType"> <summary> <para> <para>An optional parameter that lists information for a given instance type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInstanceTypeDetailListCmdlet.RetrieveAZs"> <summary> <para> <para>An optional parameter that specifies the Availability Zones for the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInstanceTypeDetailListCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</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.OS.GetOSInstanceTypeDetailListCmdlet.NextToken"> <summary> <para> <para>If your initial <c>ListInstanceTypeDetails</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>ListInstanceTypeDetails</c> operations, which returns results in the next page.</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.OS.GetOSInstanceTypeDetailListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InstanceTypeDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.ListInstanceTypeDetailsResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.ListInstanceTypeDetailsResponse 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.OS.GetOSInstanceTypeDetailListCmdlet.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.OS.GetOSInstanceTypeLimitCmdlet"> <summary> Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInstanceTypeLimitCmdlet.DomainName"> <summary> <para> <para>The name of the domain. Only specify if you need the limits for an existing domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInstanceTypeLimitCmdlet.EngineVersion"> <summary> <para> <para>Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInstanceTypeLimitCmdlet.InstanceType"> <summary> <para> <para>The OpenSearch Service instance type for which you need limit information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInstanceTypeLimitCmdlet.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.OpenSearchService.Model.DescribeInstanceTypeLimitsResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribeInstanceTypeLimitsResponse 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.OS.GetOSOutboundConnectionCmdlet"> <summary> Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>.<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.OS.GetOSOutboundConnectionCmdlet.Filter"> <summary> <para> <para>List of filter names and values that you can use for requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSOutboundConnectionCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSOutboundConnectionCmdlet.NextToken"> <summary> <para> <para>If your initial <c>DescribeOutboundConnections</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>DescribeOutboundConnections</c> operations, which returns results in the next page.</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.OS.GetOSOutboundConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Connections'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.DescribeOutboundConnectionsResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribeOutboundConnectionsResponse 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.OS.GetOSOutboundConnectionCmdlet.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.OS.GetOSPackageCmdlet"> <summary> Describes all packages available to OpenSearch Service. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages for Amazon OpenSearch Service</a>.<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.OS.GetOSPackageCmdlet.Filter"> <summary> <para> <para>Only returns packages that match the <c>DescribePackagesFilterList</c> values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSPackageCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSPackageCmdlet.NextToken"> <summary> <para> <para>If your initial <c>DescribePackageFilters</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>DescribePackageFilters</c> operations, which returns results in the next page.</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.OS.GetOSPackageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PackageDetailsList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.DescribePackagesResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribePackagesResponse 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.OS.GetOSPackageCmdlet.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.OS.GetOSPackagesForDomainListCmdlet"> <summary> Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages for Amazon OpenSearch Service</a>.<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.OS.GetOSPackagesForDomainListCmdlet.DomainName"> <summary> <para> <para>The name of the domain for which you want to list associated packages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSPackagesForDomainListCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSPackagesForDomainListCmdlet.NextToken"> <summary> <para> <para>If your initial <c>ListPackagesForDomain</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>ListPackagesForDomain</c> operations, which returns results in the next page.</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.OS.GetOSPackagesForDomainListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainPackageDetailsList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.ListPackagesForDomainResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.ListPackagesForDomainResponse 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.OS.GetOSPackagesForDomainListCmdlet.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.OS.GetOSPackageVersionHistoryCmdlet"> <summary> Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages for Amazon OpenSearch Service</a>.<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.OS.GetOSPackageVersionHistoryCmdlet.PackageID"> <summary> <para> <para>The unique identifier of the package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSPackageVersionHistoryCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSPackageVersionHistoryCmdlet.NextToken"> <summary> <para> <para>If your initial <c>GetPackageVersionHistory</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>GetPackageVersionHistory</c> operations, which returns results in the next page. </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.OS.GetOSPackageVersionHistoryCmdlet.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.OpenSearchService.Model.GetPackageVersionHistoryResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.GetPackageVersionHistoryResponse 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.OS.GetOSPackageVersionHistoryCmdlet.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.OS.GetOSReservedInstanceListCmdlet"> <summary> Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html">Reserved Instances in Amazon OpenSearch Service</a>.<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.OS.GetOSReservedInstanceListCmdlet.ReservedInstanceId"> <summary> <para> <para>The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSReservedInstanceListCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</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.OS.GetOSReservedInstanceListCmdlet.NextToken"> <summary> <para> <para>If your initial <c>DescribeReservedInstances</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>DescribeReservedInstances</c> operations, which returns results in the next page.</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.OS.GetOSReservedInstanceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReservedInstances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.DescribeReservedInstancesResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribeReservedInstancesResponse 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.OS.GetOSReservedInstanceListCmdlet.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.OS.GetOSReservedInstanceOfferingListCmdlet"> <summary> Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html">Reserved Instances in Amazon OpenSearch Service</a>.<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.OS.GetOSReservedInstanceOfferingListCmdlet.ReservedInstanceOfferingId"> <summary> <para> <para>The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSReservedInstanceOfferingListCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</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.OS.GetOSReservedInstanceOfferingListCmdlet.NextToken"> <summary> <para> <para>If your initial <c>DescribeReservedInstanceOfferings</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>DescribeReservedInstanceOfferings</c> operations, which returns results in the next page.</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.OS.GetOSReservedInstanceOfferingListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReservedInstanceOfferings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.DescribeReservedInstanceOfferingsResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribeReservedInstanceOfferingsResponse 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.OS.GetOSReservedInstanceOfferingListCmdlet.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.OS.GetOSResourceTagCmdlet"> <summary> Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html">Tagging Amazon OpenSearch Service domains</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSResourceTagCmdlet.ARN"> <summary> <para> <para>Amazon Resource Name (ARN) for the domain to view tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSResourceTagCmdlet.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.OpenSearchService.Model.ListTagsResponse). Specifying the name of a property of type Amazon.OpenSearchService.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="T:Amazon.PowerShell.Cmdlets.OS.GetOSScheduledActionListCmdlet"> <summary> Retrieves a list of configuration changes that are scheduled for a domain. These changes can be <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html">service software updates</a> or <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types">blue/green Auto-Tune enhancements</a>.<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.OS.GetOSScheduledActionListCmdlet.DomainName"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSScheduledActionListCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSScheduledActionListCmdlet.NextToken"> <summary> <para> <para>If your initial <c>ListScheduledActions</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>ListScheduledActions</c> operations, which returns results in the next page.</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.OS.GetOSScheduledActionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ScheduledActions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.ListScheduledActionsResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.ListScheduledActionsResponse 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.OS.GetOSScheduledActionListCmdlet.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.OS.GetOSUpgradeHistoryCmdlet"> <summary> Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service 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.OS.GetOSUpgradeHistoryCmdlet.DomainName"> <summary> <para> <para>The name of an existing domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSUpgradeHistoryCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</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.OS.GetOSUpgradeHistoryCmdlet.NextToken"> <summary> <para> <para>If your initial <c>GetUpgradeHistory</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>GetUpgradeHistory</c> operations, which returns results in the next page.</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.OS.GetOSUpgradeHistoryCmdlet.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.OpenSearchService.Model.GetUpgradeHistoryResponse). Specifying the name of a property of type Amazon.OpenSearchService.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.OS.GetOSUpgradeHistoryCmdlet.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.OS.GetOSUpgradeStatusCmdlet"> <summary> Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSUpgradeStatusCmdlet.DomainName"> <summary> <para> <para>The domain of the domain to get upgrade status information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSUpgradeStatusCmdlet.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.OpenSearchService.Model.GetUpgradeStatusResponse). Specifying the name of a property of type Amazon.OpenSearchService.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="T:Amazon.PowerShell.Cmdlets.OS.GetOSVersionListCmdlet"> <summary> Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.<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.OS.GetOSVersionListCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</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.OS.GetOSVersionListCmdlet.NextToken"> <summary> <para> <para>If your initial <c>ListVersions</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>ListVersions</c> operations, which returns results in the next page.</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.OS.GetOSVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Versions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.ListVersionsResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.ListVersionsResponse 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.OS.GetOSVersionListCmdlet.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.OS.GetOSVpcEndpointCmdlet"> <summary> Describes one or more Amazon OpenSearch Service-managed VPC endpoints. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSVpcEndpointCmdlet.VpcEndpointId"> <summary> <para> <para>The unique identifiers of the endpoints to get information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSVpcEndpointCmdlet.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.OpenSearchService.Model.DescribeVpcEndpointsResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DescribeVpcEndpointsResponse 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.OS.GetOSVpcEndpointAccessListCmdlet"> <summary> Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.<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.OS.GetOSVpcEndpointAccessListCmdlet.DomainName"> <summary> <para> <para>The name of the OpenSearch Service domain to retrieve access information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSVpcEndpointAccessListCmdlet.NextToken"> <summary> <para> <para>If your initial <c>ListVpcEndpointAccess</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>ListVpcEndpointAccess</c> operations, which returns results in the next page.</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.OS.GetOSVpcEndpointAccessListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AuthorizedPrincipalList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.ListVpcEndpointAccessResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.ListVpcEndpointAccessResponse 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.OS.GetOSVpcEndpointAccessListCmdlet.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.OS.GetOSVpcEndpointListCmdlet"> <summary> Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.<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.OS.GetOSVpcEndpointListCmdlet.NextToken"> <summary> <para> <para>If your initial <c>ListVpcEndpoints</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>ListVpcEndpoints</c> operations, which returns results in the next page.</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.OS.GetOSVpcEndpointListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VpcEndpointSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.ListVpcEndpointsResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.ListVpcEndpointsResponse 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.OS.GetOSVpcEndpointListCmdlet.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.OS.GetOSVpcEndpointsForDomainListCmdlet"> <summary> Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular 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.OS.GetOSVpcEndpointsForDomainListCmdlet.DomainName"> <summary> <para> <para>The name of the domain to list associated VPC endpoints for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSVpcEndpointsForDomainListCmdlet.NextToken"> <summary> <para> <para>If your initial <c>ListEndpointsForDomain</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>ListEndpointsForDomain</c> operations, which returns results in the next page.</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.OS.GetOSVpcEndpointsForDomainListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VpcEndpointSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.ListVpcEndpointsForDomainResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.ListVpcEndpointsForDomainResponse 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.OS.GetOSVpcEndpointsForDomainListCmdlet.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.OS.NewOSDomainCmdlet"> <summary> Creates an Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html">Creating and managing Amazon OpenSearch Service domains</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AccessPolicy"> <summary> <para> <para>Identity and Access Management (IAM) policy document specifying the access policies for the new domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AdvancedOption"> <summary> <para> <para>Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:</para><ul><li><para><c>"rest.action.multi.allow_explicit_index": "true" | "false"</c> - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.</para></li><li><para><c>"indices.fielddata.cache.size": "80" </c> - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.</para></li><li><para><c>"indices.query.bool.max_clause_count": "1024"</c> - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a <c>TooManyClauses</c> error.</para></li><li><para><c>"override_main_response_version": "true" | "false"</c> - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options">Advanced cluster parameters</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AdvancedSecurityOptions_AnonymousAuthEnabled"> <summary> <para> <para>True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing">enabling fine-grained access control on an existing domain</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.SnapshotOptions_AutomatedSnapshotStartHour"> <summary> <para> <para>The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is <c>0</c> hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.SoftwareUpdateOptions_AutoSoftwareUpdateEnabled"> <summary> <para> <para>Whether automatic service software updates are enabled for the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ZoneAwarenessConfig_AvailabilityZoneCount"> <summary> <para> <para>If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are <c>2</c> and <c>3</c>. If your domain is provisioned within a VPC, this value be equal to number of subnets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.DomainEndpointOptions_CustomEndpoint"> <summary> <para> <para>The fully qualified URL for the custom endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.DomainEndpointOptions_CustomEndpointCertificateArn"> <summary> <para> <para>The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.DomainEndpointOptions_CustomEndpointEnabled"> <summary> <para> <para>Whether to enable a custom endpoint for the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_DedicatedMasterCount"> <summary> <para> <para>Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_DedicatedMasterEnabled"> <summary> <para> <para>Indicates whether dedicated master nodes are enabled for the cluster.<c>True</c> if the cluster will use a dedicated master node.<c>False</c> if the cluster will not.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_DedicatedMasterType"> <summary> <para> <para>OpenSearch Service instance type of the dedicated master nodes in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.NaturalLanguageQueryGenerationOptions_DesiredState"> <summary> <para> <para>The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AutoTuneOptions_DesiredState"> <summary> <para> <para>Whether Auto-Tune is enabled or disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.DomainName"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.EBSOptions_EBSEnabled"> <summary> <para> <para>Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AdvancedSecurityOptions_Enabled"> <summary> <para> <para>True to enable fine-grained access control.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.JWTOptions_Enabled"> <summary> <para> <para>True to enable JWT authentication and authorization for a domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.SAMLOptions_Enabled"> <summary> <para> <para>True to enable SAML authentication for a domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ColdStorageOptions_Enabled"> <summary> <para> <para>Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.CognitoOptions_Enabled"> <summary> <para> <para>Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.EncryptionAtRestOptions_Enabled"> <summary> <para> <para>True to enable encryption at rest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.NodeToNodeEncryptionOptions_Enabled"> <summary> <para> <para>True to enable node-to-node encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.OffPeakWindowOptions_Enabled"> <summary> <para> <para>Whether to enable an off-peak window.</para><para>This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.DomainEndpointOptions_EnforceHTTPS"> <summary> <para> <para>True to require that all traffic to the domain arrive over HTTPS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.EngineVersion"> <summary> <para> <para>String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, <c>OpenSearch_1.0</c> or <c>Elasticsearch_7.9</c>. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains">Creating and managing Amazon OpenSearch Service domains</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.Idp_EntityId"> <summary> <para> <para>The unique entity ID of the application in the SAML identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.WindowStartTime_Hour"> <summary> <para> <para>The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, <c>17</c> refers to 5:00 P.M. UTC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.CognitoOptions_IdentityPoolId"> <summary> <para> <para>The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_InstanceCount"> <summary> <para> <para>Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_InstanceType"> <summary> <para> <para>Instance type of data nodes in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AdvancedSecurityOptions_InternalUserDatabaseEnabled"> <summary> <para> <para>True to enable the internal user database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.EBSOptions_Iops"> <summary> <para> <para>Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the <c>gp3</c> and provisioned IOPS EBS volume types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.IPAddressType"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.EncryptionAtRestOptions_KmsKeyId"> <summary> <para> <para>The KMS key ID. Takes the form <c>1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.LogPublishingOption"> <summary> <para> <para>Key-value pairs to configure log publishing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AutoTuneOptions_MaintenanceSchedule"> <summary> <para> <para>A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">off-peak windows</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.SAMLOptions_MasterBackendRole"> <summary> <para> <para>The backend role that the SAML master user is mapped to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.MasterUserOptions_MasterUserARN"> <summary> <para> <para>Amazon Resource Name (ARN) for the master user. Only specify if <c>InternalUserDatabaseEnabled</c> is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.MasterUserOptions_MasterUserName"> <summary> <para> <para>User name for the master user. Only specify if <c>InternalUserDatabaseEnabled</c> is <c>true</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.SAMLOptions_MasterUserName"> <summary> <para> <para>The SAML master user name, which is stored in the domain's internal user database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.MasterUserOptions_MasterUserPassword"> <summary> <para> <para>Password for the master user. Only specify if <c>InternalUserDatabaseEnabled</c> is <c>true</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.Idp_MetadataContent"> <summary> <para> <para>The metadata of the SAML application, in XML format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.WindowStartTime_Minute"> <summary> <para> <para>The start minute of the window, in UTC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_MultiAZWithStandbyEnabled"> <summary> <para> <para>A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html">Configuring a multi-AZ domain in Amazon OpenSearch Service</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.JWTOptions_PublicKey"> <summary> <para> <para>Element of the JWT assertion used by the cluster to verify JWT signatures.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.CognitoOptions_RoleArn"> <summary> <para> <para>The <c>AmazonOpenSearchServiceCognitoAccess</c> role that allows OpenSearch Service to configure your user pool and identity pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.JWTOptions_RolesKey"> <summary> <para> <para>Element of the JWT assertion to use for roles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.SAMLOptions_RolesKey"> <summary> <para> <para>Element of the SAML assertion to use for backend roles. Default is <c>roles</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.VPCOptions_SecurityGroupId"> <summary> <para> <para>The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.SAMLOptions_SessionTimeoutMinute"> <summary> <para> <para>The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.JWTOptions_SubjectKey"> <summary> <para> <para>Element of the JWT assertion to use for the user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.SAMLOptions_SubjectKey"> <summary> <para> <para>Element of the SAML assertion to use for the user name. Default is <c>NameID</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.VPCOptions_SubnetId"> <summary> <para> <para>A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.TagList"> <summary> <para> <para>List of tags to add to the domain upon creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.EBSOptions_Throughput"> <summary> <para> <para>Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the <c>gp3</c> volume type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.DomainEndpointOptions_TLSSecurityPolicy"> <summary> <para> <para>Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:</para><ul><li><para><b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy that supports TLS version 1.0 to TLS version 1.2</para></li><li><para><b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy that supports only TLS version 1.2</para></li><li><para><b>Policy-Min-TLS-1-2-PFS-2023-10:</b> TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AutoTuneOptions_UseOffPeakWindow"> <summary> <para> <para>Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.CognitoOptions_UserPoolId"> <summary> <para> <para>The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.EBSOptions_VolumeSize"> <summary> <para> <para>Specifies the size (in GiB) of EBS volumes attached to data nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.EBSOptions_VolumeType"> <summary> <para> <para>Specifies the type of EBS volumes attached to data nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_WarmCount"> <summary> <para> <para>The number of warm nodes in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_WarmEnabled"> <summary> <para> <para>Whether to enable warm storage for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_WarmType"> <summary> <para> <para>The instance type for the cluster's warm nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_ZoneAwarenessEnabled"> <summary> <para> <para>Indicates whether multiple Availability Zones are enabled. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html">Configuring a multi-AZ domain in Amazon OpenSearch Service</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.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.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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.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.OS.NewOSOutboundConnectionCmdlet"> <summary> Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSOutboundConnectionCmdlet.ConnectionAlias"> <summary> <para> <para>Name of the connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSOutboundConnectionCmdlet.ConnectionMode"> <summary> <para> <para>The connection mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSOutboundConnectionCmdlet.LocalDomainInfo_AWSDomainInformation_DomainName"> <summary> <para> <para>Name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSOutboundConnectionCmdlet.RemoteDomainInfo_AWSDomainInformation_DomainName"> <summary> <para> <para>Name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSOutboundConnectionCmdlet.ConnectionProperties_Endpoint"> <summary> <para> <important><para>The Endpoint attribute cannot be modified. </para></important><para>The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSOutboundConnectionCmdlet.LocalDomainInfo_AWSDomainInformation_OwnerId"> <summary> <para> <para>The Amazon Web Services account ID of the domain owner.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSOutboundConnectionCmdlet.RemoteDomainInfo_AWSDomainInformation_OwnerId"> <summary> <para> <para>The Amazon Web Services account ID of the domain owner.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSOutboundConnectionCmdlet.LocalDomainInfo_AWSDomainInformation_Region"> <summary> <para> <para>The Amazon Web Services Region in which the domain is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSOutboundConnectionCmdlet.RemoteDomainInfo_AWSDomainInformation_Region"> <summary> <para> <para>The Amazon Web Services Region in which the domain is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSOutboundConnectionCmdlet.CrossClusterSearch_SkipUnavailable"> <summary> <para> <para>The status of the <c>SkipUnavailable</c> setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSOutboundConnectionCmdlet.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.OpenSearchService.Model.CreateOutboundConnectionResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.CreateOutboundConnectionResponse 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.OS.NewOSOutboundConnectionCmdlet.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.OS.NewOSPackageCmdlet"> <summary> Creates a package for use with Amazon OpenSearch Service domains. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages for Amazon OpenSearch Service</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSPackageCmdlet.PackageDescription"> <summary> <para> <para>Description of the package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSPackageCmdlet.PackageName"> <summary> <para> <para>Unique name for the package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSPackageCmdlet.PackageType"> <summary> <para> <para>The type of package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSPackageCmdlet.PackageSource_S3BucketName"> <summary> <para> <para>The name of the Amazon S3 bucket containing the package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSPackageCmdlet.PackageSource_S3Key"> <summary> <para> <para>Key (file name) of the package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSPackageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PackageDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.CreatePackageResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.CreatePackageResponse 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.OS.NewOSPackageCmdlet.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.OS.NewOSReservedInstanceOfferingCmdlet"> <summary> Allows you to purchase Amazon OpenSearch Service Reserved Instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSReservedInstanceOfferingCmdlet.InstanceCount"> <summary> <para> <para>The number of OpenSearch instances to reserve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSReservedInstanceOfferingCmdlet.ReservationName"> <summary> <para> <para>A customer-specified identifier to track this reservation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSReservedInstanceOfferingCmdlet.ReservedInstanceOfferingId"> <summary> <para> <para>The ID of the Reserved Instance offering to purchase.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSReservedInstanceOfferingCmdlet.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.OpenSearchService.Model.PurchaseReservedInstanceOfferingResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.PurchaseReservedInstanceOfferingResponse 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.OS.NewOSReservedInstanceOfferingCmdlet.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.OS.NewOSVpcEndpointCmdlet"> <summary> Creates an Amazon OpenSearch Service-managed VPC endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSVpcEndpointCmdlet.DomainArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the domain to create the endpoint for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSVpcEndpointCmdlet.VpcOptions_SecurityGroupId"> <summary> <para> <para>The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSVpcEndpointCmdlet.VpcOptions_SubnetId"> <summary> <para> <para>A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSVpcEndpointCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSVpcEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VpcEndpoint'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.CreateVpcEndpointResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.CreateVpcEndpointResponse 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.OS.NewOSVpcEndpointCmdlet.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.OS.RemoveOSDataSourceCmdlet"> <summary> Deletes a direct-query data source. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-delete.html">Deleting an Amazon OpenSearch Service data source with Amazon S3</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSDataSourceCmdlet.DomainName"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSDataSourceCmdlet.Name"> <summary> <para> <para>The name of the data source to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Message'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.DeleteDataSourceResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DeleteDataSourceResponse 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.OS.RemoveOSDataSourceCmdlet.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.OS.RemoveOSDomainCmdlet"> <summary> Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSDomainCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to permanently delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSDomainCmdlet.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.OpenSearchService.Model.DeleteDomainResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DeleteDomainResponse 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.OS.RemoveOSDomainCmdlet.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.OS.RemoveOSInboundConnectionCmdlet"> <summary> Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSInboundConnectionCmdlet.ConnectionId"> <summary> <para> <para>The ID of the inbound connection to permanently delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSInboundConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Connection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.DeleteInboundConnectionResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DeleteInboundConnectionResponse 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.OS.RemoveOSInboundConnectionCmdlet.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.OS.RemoveOSOutboundConnectionCmdlet"> <summary> Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSOutboundConnectionCmdlet.ConnectionId"> <summary> <para> <para>The ID of the outbound connection you want to permanently delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSOutboundConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Connection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.DeleteOutboundConnectionResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DeleteOutboundConnectionResponse 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.OS.RemoveOSOutboundConnectionCmdlet.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.OS.RemoveOSPackageCmdlet"> <summary> Deletes an Amazon OpenSearch Service package. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages for Amazon OpenSearch Service</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSPackageCmdlet.PackageID"> <summary> <para> <para>The internal ID of the package you want to delete. Use <c>DescribePackages</c> to find this value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSPackageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PackageDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.DeletePackageResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DeletePackageResponse 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.OS.RemoveOSPackageCmdlet.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.OS.RemoveOSResourceTagCmdlet"> <summary> Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging"> Tagging Amazon OpenSearch Service domains</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSResourceTagCmdlet.ARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSResourceTagCmdlet.TagKey"> <summary> <para> <para>The list of tag keys to remove from the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSResourceTagCmdlet.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.OpenSearchService.Model.RemoveTagsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSResourceTagCmdlet.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.OS.RemoveOSVpcEndpointCmdlet"> <summary> Deletes an Amazon OpenSearch Service-managed interface VPC endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSVpcEndpointCmdlet.VpcEndpointId"> <summary> <para> <para>The unique identifier of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSVpcEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VpcEndpointSummary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.DeleteVpcEndpointResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DeleteVpcEndpointResponse 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.OS.RemoveOSVpcEndpointCmdlet.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.OS.RevokeOSVpcEndpointAccessCmdlet"> <summary> Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RevokeOSVpcEndpointAccessCmdlet.Account"> <summary> <para> <para>The account ID to revoke access from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RevokeOSVpcEndpointAccessCmdlet.DomainName"> <summary> <para> <para>The name of the OpenSearch Service domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RevokeOSVpcEndpointAccessCmdlet.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.OpenSearchService.Model.RevokeVpcEndpointAccessResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RevokeOSVpcEndpointAccessCmdlet.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.OS.StartOSAssociatePackageCmdlet"> <summary> Associates a package with an Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages for Amazon OpenSearch Service</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSAssociatePackageCmdlet.DomainName"> <summary> <para> <para>Name of the domain to associate the package with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSAssociatePackageCmdlet.PackageID"> <summary> <para> <para>Internal ID of the package to associate with a domain. Use <c>DescribePackages</c> to find this value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSAssociatePackageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainPackageDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.AssociatePackageResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.AssociatePackageResponse 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.OS.StartOSAssociatePackageCmdlet.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.OS.StartOSDissociatePackageCmdlet"> <summary> Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages for Amazon OpenSearch Service</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSDissociatePackageCmdlet.DomainName"> <summary> <para> <para>Name of the domain to dissociate the package from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSDissociatePackageCmdlet.PackageID"> <summary> <para> <para>Internal ID of the package to dissociate from the domain. Use <c>ListPackagesForDomain</c> to find this value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSDissociatePackageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainPackageDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.DissociatePackageResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.DissociatePackageResponse 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.OS.StartOSDissociatePackageCmdlet.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.OS.StartOSDomainMaintenanceCmdlet"> <summary> Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSDomainMaintenanceCmdlet.Action"> <summary> <para> <para>The name of the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSDomainMaintenanceCmdlet.DomainName"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSDomainMaintenanceCmdlet.NodeId"> <summary> <para> <para>The ID of the data node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSDomainMaintenanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MaintenanceId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.StartDomainMaintenanceResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.StartDomainMaintenanceResponse 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.OS.StartOSDomainMaintenanceCmdlet.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.OS.StartOSServiceSoftwareUpdateCmdlet"> <summary> Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html">Service software updates in Amazon OpenSearch Service</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSServiceSoftwareUpdateCmdlet.DesiredStartTime"> <summary> <para> <para>The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set <c>ScheduleAt</c> to <c>TIMESTAMP</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSServiceSoftwareUpdateCmdlet.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.OS.StartOSServiceSoftwareUpdateCmdlet.ScheduleAt"> <summary> <para> <para>When to start the service software update.</para><ul><li><para><c>NOW</c> - Immediately schedules the update to happen in the current hour if there's capacity available.</para></li><li><para><c>TIMESTAMP</c> - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for <c>DesiredStartTime</c>.</para></li><li><para><c>OFF_PEAK_WINDOW</c> - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.</para></li></ul><para>Default: <c>NOW</c> if you don't specify a value for <c>DesiredStartTime</c>, and <c>TIMESTAMP</c> if you do.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSServiceSoftwareUpdateCmdlet.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.OpenSearchService.Model.StartServiceSoftwareUpdateResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.StartServiceSoftwareUpdateResponse 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.OS.StartOSServiceSoftwareUpdateCmdlet.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.OS.StopOSDomainConfigChangeCmdlet"> <summary> Cancels a pending configuration change on an Amazon OpenSearch Service domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StopOSDomainConfigChangeCmdlet.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.OS.StopOSDomainConfigChangeCmdlet.DryRun"> <summary> <para> <para>When set to <c>True</c>, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StopOSDomainConfigChangeCmdlet.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.OpenSearchService.Model.CancelDomainConfigChangeResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.CancelDomainConfigChangeResponse 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.OS.StopOSDomainConfigChangeCmdlet.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.OS.StopOSServiceSoftwareUpdateCmdlet"> <summary> Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the <c>AutomatedUpdateDate</c> and when the domain's <c>UpdateStatus</c> is <c>PENDING_UPDATE</c>. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html">Service software updates in Amazon OpenSearch Service</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StopOSServiceSoftwareUpdateCmdlet.DomainName"> <summary> <para> <para>Name of the OpenSearch Service domain that you want to cancel the service software update on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StopOSServiceSoftwareUpdateCmdlet.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.OpenSearchService.Model.CancelServiceSoftwareUpdateResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.CancelServiceSoftwareUpdateResponse 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.OS.StopOSServiceSoftwareUpdateCmdlet.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.OS.UpdateOSDataSourceCmdlet"> <summary> Updates a direct-query data source. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html">Working with Amazon OpenSearch Service data source integrations with Amazon S3</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDataSourceCmdlet.Description"> <summary> <para> <para>A new description of the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDataSourceCmdlet.DomainName"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDataSourceCmdlet.Name"> <summary> <para> <para>The name of the data source to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDataSourceCmdlet.S3GlueDataCatalog_RoleArn"> <summary> <para> <para>>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDataSourceCmdlet.Status"> <summary> <para> <para>The status of the data source update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Message'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.UpdateDataSourceResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.UpdateDataSourceResponse 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.OS.UpdateOSDataSourceCmdlet.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.OS.UpdateOSDomainCmdlet"> <summary> Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainCmdlet.AdvancedOption"> <summary> <para> <para>Only supports the <c>override_main_response_version</c> parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainCmdlet.DomainName"> <summary> <para> <para>Name of the OpenSearch Service domain that you want to upgrade.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainCmdlet.PerformCheckOnly"> <summary> <para> <para>When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainCmdlet.TargetVersion"> <summary> <para> <para>OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainCmdlet.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.OpenSearchService.Model.UpgradeDomainResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.UpgradeDomainResponse 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.OS.UpdateOSDomainCmdlet.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.OS.UpdateOSDomainConfigCmdlet"> <summary> Modifies the cluster configuration of the specified Amazon OpenSearch Service domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AccessPolicy"> <summary> <para> <para>Identity and Access Management (IAM) access policy as a JSON-formatted string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AdvancedOption"> <summary> <para> <para>Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:</para><ul><li><para><c>"rest.action.multi.allow_explicit_index": "true" | "false"</c> - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.</para></li><li><para><c>"indices.fielddata.cache.size": "80" </c> - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.</para></li><li><para><c>"indices.query.bool.max_clause_count": "1024"</c> - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a <c>TooManyClauses</c> error.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options">Advanced cluster parameters</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AdvancedSecurityOptions_AnonymousAuthEnabled"> <summary> <para> <para>True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing">enabling fine-grained access control on an existing domain</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.SnapshotOptions_AutomatedSnapshotStartHour"> <summary> <para> <para>The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is <c>0</c> hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.SoftwareUpdateOptions_AutoSoftwareUpdateEnabled"> <summary> <para> <para>Whether automatic service software updates are enabled for the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ZoneAwarenessConfig_AvailabilityZoneCount"> <summary> <para> <para>If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are <c>2</c> and <c>3</c>. If your domain is provisioned within a VPC, this value be equal to number of subnets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.DomainEndpointOptions_CustomEndpoint"> <summary> <para> <para>The fully qualified URL for the custom endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.DomainEndpointOptions_CustomEndpointCertificateArn"> <summary> <para> <para>The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.DomainEndpointOptions_CustomEndpointEnabled"> <summary> <para> <para>Whether to enable a custom endpoint for the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_DedicatedMasterCount"> <summary> <para> <para>Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_DedicatedMasterEnabled"> <summary> <para> <para>Indicates whether dedicated master nodes are enabled for the cluster.<c>True</c> if the cluster will use a dedicated master node.<c>False</c> if the cluster will not.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_DedicatedMasterType"> <summary> <para> <para>OpenSearch Service instance type of the dedicated master nodes in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.NaturalLanguageQueryGenerationOptions_DesiredState"> <summary> <para> <para>The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AutoTuneOptions_DesiredState"> <summary> <para> <para>Whether Auto-Tune is enabled or disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.DomainName"> <summary> <para> <para>The name of the domain that you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.DryRun"> <summary> <para> <para>This flag, when set to True, specifies whether the <c>UpdateDomain</c> request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.DryRunMode"> <summary> <para> <para>The type of dry run to perform.</para><ul><li><para><c>Basic</c> only returns the type of deployment (blue/green or dynamic) that the update will cause.</para></li><li><para><c>Verbose</c> runs an additional check to validate the changes you're making. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#validation-check">Validating a domain update</a>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.EBSOptions_EBSEnabled"> <summary> <para> <para>Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AdvancedSecurityOptions_Enabled"> <summary> <para> <para>True to enable fine-grained access control.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.JWTOptions_Enabled"> <summary> <para> <para>True to enable JWT authentication and authorization for a domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.SAMLOptions_Enabled"> <summary> <para> <para>True to enable SAML authentication for a domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ColdStorageOptions_Enabled"> <summary> <para> <para>Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.CognitoOptions_Enabled"> <summary> <para> <para>Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.EncryptionAtRestOptions_Enabled"> <summary> <para> <para>True to enable encryption at rest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.NodeToNodeEncryptionOptions_Enabled"> <summary> <para> <para>True to enable node-to-node encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.OffPeakWindowOptions_Enabled"> <summary> <para> <para>Whether to enable an off-peak window.</para><para>This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.DomainEndpointOptions_EnforceHTTPS"> <summary> <para> <para>True to require that all traffic to the domain arrive over HTTPS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.Idp_EntityId"> <summary> <para> <para>The unique entity ID of the application in the SAML identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.WindowStartTime_Hour"> <summary> <para> <para>The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, <c>17</c> refers to 5:00 P.M. UTC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.CognitoOptions_IdentityPoolId"> <summary> <para> <para>The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_InstanceCount"> <summary> <para> <para>Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_InstanceType"> <summary> <para> <para>Instance type of data nodes in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AdvancedSecurityOptions_InternalUserDatabaseEnabled"> <summary> <para> <para>True to enable the internal user database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.EBSOptions_Iops"> <summary> <para> <para>Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the <c>gp3</c> and provisioned IOPS EBS volume types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.IPAddressType"> <summary> <para> <para>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 your IP address type is currently set to dual stack, you can't change it. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.EncryptionAtRestOptions_KmsKeyId"> <summary> <para> <para>The KMS key ID. Takes the form <c>1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.LogPublishingOption"> <summary> <para> <para>Options to publish OpenSearch logs to Amazon CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AutoTuneOptions_MaintenanceSchedule"> <summary> <para> <para>DEPRECATED. Use <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">off-peak window</a> instead.</para><para>A list of maintenance schedules during which Auto-Tune can deploy changes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.SAMLOptions_MasterBackendRole"> <summary> <para> <para>The backend role that the SAML master user is mapped to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.MasterUserOptions_MasterUserARN"> <summary> <para> <para>Amazon Resource Name (ARN) for the master user. Only specify if <c>InternalUserDatabaseEnabled</c> is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.MasterUserOptions_MasterUserName"> <summary> <para> <para>User name for the master user. Only specify if <c>InternalUserDatabaseEnabled</c> is <c>true</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.SAMLOptions_MasterUserName"> <summary> <para> <para>The SAML master user name, which is stored in the domain's internal user database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.MasterUserOptions_MasterUserPassword"> <summary> <para> <para>Password for the master user. Only specify if <c>InternalUserDatabaseEnabled</c> is <c>true</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.Idp_MetadataContent"> <summary> <para> <para>The metadata of the SAML application, in XML format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.WindowStartTime_Minute"> <summary> <para> <para>The start minute of the window, in UTC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_MultiAZWithStandbyEnabled"> <summary> <para> <para>A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html">Configuring a multi-AZ domain in Amazon OpenSearch Service</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.JWTOptions_PublicKey"> <summary> <para> <para>Element of the JWT assertion used by the cluster to verify JWT signatures.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.CognitoOptions_RoleArn"> <summary> <para> <para>The <c>AmazonOpenSearchServiceCognitoAccess</c> role that allows OpenSearch Service to configure your user pool and identity pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.JWTOptions_RolesKey"> <summary> <para> <para>Element of the JWT assertion to use for roles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.SAMLOptions_RolesKey"> <summary> <para> <para>Element of the SAML assertion to use for backend roles. Default is <c>roles</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AutoTuneOptions_RollbackOnDisable"> <summary> <para> <para>When disabling Auto-Tune, specify <c>NO_ROLLBACK</c> to retain all prior Auto-Tune settings or <c>DEFAULT_ROLLBACK</c> to revert to the OpenSearch Service defaults. If you specify <c>DEFAULT_ROLLBACK</c>, you must include a <c>MaintenanceSchedule</c> in the request. Otherwise, OpenSearch Service is unable to perform the rollback.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.VPCOptions_SecurityGroupId"> <summary> <para> <para>The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.SAMLOptions_SessionTimeoutMinute"> <summary> <para> <para>The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.JWTOptions_SubjectKey"> <summary> <para> <para>Element of the JWT assertion to use for the user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.SAMLOptions_SubjectKey"> <summary> <para> <para>Element of the SAML assertion to use for the user name. Default is <c>NameID</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.VPCOptions_SubnetId"> <summary> <para> <para>A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.EBSOptions_Throughput"> <summary> <para> <para>Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the <c>gp3</c> volume type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.DomainEndpointOptions_TLSSecurityPolicy"> <summary> <para> <para>Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:</para><ul><li><para><b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy that supports TLS version 1.0 to TLS version 1.2</para></li><li><para><b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy that supports only TLS version 1.2</para></li><li><para><b>Policy-Min-TLS-1-2-PFS-2023-10:</b> TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AutoTuneOptions_UseOffPeakWindow"> <summary> <para> <para>Whether to use the domain's <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html">off-peak window</a> to deploy configuration changes on the domain rather than a maintenance schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.CognitoOptions_UserPoolId"> <summary> <para> <para>The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.EBSOptions_VolumeSize"> <summary> <para> <para>Specifies the size (in GiB) of EBS volumes attached to data nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.EBSOptions_VolumeType"> <summary> <para> <para>Specifies the type of EBS volumes attached to data nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_WarmCount"> <summary> <para> <para>The number of warm nodes in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_WarmEnabled"> <summary> <para> <para>Whether to enable warm storage for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_WarmType"> <summary> <para> <para>The instance type for the cluster's warm nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_ZoneAwarenessEnabled"> <summary> <para> <para>Indicates whether multiple Availability Zones are enabled. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html">Configuring a multi-AZ domain in Amazon OpenSearch Service</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.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.OpenSearchService.Model.UpdateDomainConfigResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.UpdateDomainConfigResponse 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.OS.UpdateOSDomainConfigCmdlet.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.OS.UpdateOSPackageCmdlet"> <summary> Updates a package for use with Amazon OpenSearch Service domains. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages for Amazon OpenSearch Service</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSPackageCmdlet.CommitMessage"> <summary> <para> <para>Commit message for the updated file, which is shown as part of <c>GetPackageVersionHistoryResponse</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSPackageCmdlet.PackageDescription"> <summary> <para> <para>A new description of the package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSPackageCmdlet.PackageID"> <summary> <para> <para>The unique identifier for the package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSPackageCmdlet.PackageSource_S3BucketName"> <summary> <para> <para>The name of the Amazon S3 bucket containing the package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSPackageCmdlet.PackageSource_S3Key"> <summary> <para> <para>Key (file name) of the package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSPackageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PackageDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.UpdatePackageResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.UpdatePackageResponse 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.OS.UpdateOSPackageCmdlet.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.OS.UpdateOSScheduledActionCmdlet"> <summary> Reschedules a planned domain configuration change for a later time. This change can be a scheduled <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html">service software update</a> or a <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types">blue/green Auto-Tune enhancement</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSScheduledActionCmdlet.ActionID"> <summary> <para> <para>The unique identifier of the action to reschedule. To retrieve this ID, send a <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html">ListScheduledActions</a> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSScheduledActionCmdlet.ActionType"> <summary> <para> <para>The type of action to reschedule. Can be one of <c>SERVICE_SOFTWARE_UPDATE</c>, <c>JVM_HEAP_SIZE_TUNING</c>, or <c>JVM_YOUNG_GEN_TUNING</c>. To retrieve this value, send a <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html">ListScheduledActions</a> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSScheduledActionCmdlet.DesiredStartTime"> <summary> <para> <para>The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set <c>ScheduleAt</c> to <c>TIMESTAMP</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSScheduledActionCmdlet.DomainName"> <summary> <para> <para>The name of the domain to reschedule an action for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSScheduledActionCmdlet.ScheduleAt"> <summary> <para> <para>When to schedule the action.</para><ul><li><para><c>NOW</c> - Immediately schedules the update to happen in the current hour if there's capacity available.</para></li><li><para><c>TIMESTAMP</c> - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for <c>DesiredStartTime</c>.</para></li><li><para><c>OFF_PEAK_WINDOW</c> - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSScheduledActionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ScheduledAction'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.UpdateScheduledActionResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.UpdateScheduledActionResponse 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.OS.UpdateOSScheduledActionCmdlet.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.OS.UpdateOSVpcEndpointCmdlet"> <summary> Modifies an Amazon OpenSearch Service-managed interface VPC endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSVpcEndpointCmdlet.VpcOptions_SecurityGroupId"> <summary> <para> <para>The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSVpcEndpointCmdlet.VpcOptions_SubnetId"> <summary> <para> <para>A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSVpcEndpointCmdlet.VpcEndpointId"> <summary> <para> <para>The unique identifier of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSVpcEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VpcEndpoint'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchService.Model.UpdateVpcEndpointResponse). Specifying the name of a property of type Amazon.OpenSearchService.Model.UpdateVpcEndpointResponse 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.OS.UpdateOSVpcEndpointCmdlet.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> |