AWS.Tools.OpenSearchService.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.OpenSearchService</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.OS.AddOSResourceTagCmdlet"> <summary> Attaches tags to an existing domain. Tags are a set of case-sensitive key value pairs. An domain can have up to 10 tags. See <a href="http://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging" target="_blank"> Tagging Amazon OpenSearch Service domains</a> for more information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.AddOSResourceTagCmdlet.ARN"> <summary> <para> <para>Specify the <code>ARN</code> of the domain you want to add tags to. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.AddOSResourceTagCmdlet.TagList"> <summary> <para> <para>List of <code>Tag</code> to add to the domain. </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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TagList parameter. The -PassThru parameter is deprecated, use -Select '^TagList' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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 remote domain owner to accept an inbound cross-cluster connection request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.ApproveOSInboundConnectionCmdlet.ConnectionId"> <summary> <para> <para>The ID of the inbound connection you want 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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionId parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionId' instead. This parameter will be removed in a future version. </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.DenyOSInboundConnectionCmdlet"> <summary> Allows the remote 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 ID 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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionId parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionId' instead. This parameter will be removed in a future version. </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 list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a <code><a>DomainName</a></code> to get all upgrade-compatible versions of OpenSearch/Elasticsearch for that specific domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSCompatibleVersionCmdlet.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.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="P:Amazon.PowerShell.Cmdlets.OS.GetOSCompatibleVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OS.GetOSDomainCmdlet"> <summary> Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainCmdlet.DomainName"> <summary> <para> <para>The name of the domain for which you want information.</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="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OS.GetOSDomainAutoTuneCmdlet"> <summary> Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.<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>The domain name for which you want Auto-Tune action details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainAutoTuneCmdlet.MaxResult"> <summary> <para> <para>Set this value to limit the number of results returned. If not specified, defaults to 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainAutoTuneCmdlet.NextToken"> <summary> <para> <para>NextToken is sent in case the earlier API call results contain the NextToken. Used for pagination.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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 a domain, including a change ID, status, and progress stages. </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. This is an optional parameter. If omitted, the service 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 domain you want to get the progress information about.</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="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainChangeProgressCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OS.GetOSDomainConfigCmdlet"> <summary> Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainConfigCmdlet.DomainName"> <summary> <para> <para>The domain you want to get information about.</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="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OS.GetOSDomainListCmdlet"> <summary> Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainListCmdlet.DomainName"> <summary> <para> <para>The domains for which you want information.</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="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OS.GetOSDomainNameListCmdlet"> <summary> Returns the names of all domains owned by the current user's account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainNameListCmdlet.EngineType"> <summary> <para> <para> Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'. </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.GetOSDomainsForPackageListCmdlet"> <summary> Lists all Amazon OpenSearch Service domains associated with the package.<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 package for which to list associated domains.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainsForPackageListCmdlet.MaxResult"> <summary> <para> <para>Limits the results to a maximum number of domains.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSDomainsForPackageListCmdlet.NextToken"> <summary> <para> <para>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for 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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PackageID parameter. The -PassThru parameter is deprecated, use -Select '^PackageID' instead. This parameter will be removed in a future version. </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.GetOSInboundConnectionCmdlet"> <summary> Lists all the inbound cross-cluster connections for a remote 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.GetOSInboundConnectionCmdlet.Filter"> <summary> <para> <para> A list of filters used to match properties for inbound cross-cluster connections. Available <code><a>Filter</a></code> values are: <ul><li>connection-id</li><li>local-domain-info.domain-name</li><li>local-domain-info.owner-id</li><li>local-domain-info.region</li><li>remote-domain-info.domain-name</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInboundConnectionCmdlet.MaxResult"> <summary> <para> <para>Set this value to limit the number of results returned. If not specified, defaults to 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInboundConnectionCmdlet.NextToken"> <summary> <para> <para>If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.</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> <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> 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.GetOSInstanceTypeDetailListCmdlet.EngineVersion"> <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.GetOSInstanceTypeDetailListCmdlet.MaxResult"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInstanceTypeDetailListCmdlet.NextToken"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EngineVersion parameter. The -PassThru parameter is deprecated, use -Select '^EngineVersion' instead. This parameter will be removed in a future version. </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> Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the <code><a>DomainName</a></code> to see which limits you can modify. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInstanceTypeLimitCmdlet.DomainName"> <summary> <para> <para> The name of the domain you want to modify. Only include this value if you're querying OpenSearch <code><a>Limits</a></code> for an existing domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInstanceTypeLimitCmdlet.EngineVersion"> <summary> <para> <para> Version of OpenSearch for which <code><a>Limits</a></code> are needed. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSInstanceTypeLimitCmdlet.InstanceType"> <summary> <para> <para> The instance type for an OpenSearch cluster for which OpenSearch <code><a>Limits</a></code> are needed. </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="P:Amazon.PowerShell.Cmdlets.OS.GetOSInstanceTypeLimitCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OS.GetOSOutboundConnectionCmdlet"> <summary> Lists all the outbound cross-cluster connections for a local 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.GetOSOutboundConnectionCmdlet.Filter"> <summary> <para> <para> A list of filters used to match properties for outbound cross-cluster connections. Available <code><a>Filter</a></code> names for this operation are: <ul><li>connection-id</li><li>remote-domain-info.domain-name</li><li>remote-domain-info.owner-id</li><li>remote-domain-info.region</li><li>local-domain-info.domain-name</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSOutboundConnectionCmdlet.MaxResult"> <summary> <para> <para>Set this value to limit the number of results returned. If not specified, defaults to 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSOutboundConnectionCmdlet.NextToken"> <summary> <para> <para>NextToken is sent in case the earlier API call results contain the NextToken parameter. Used for pagination.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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 Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.<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 <code>DescribePackagesFilterList</code> values. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSPackageCmdlet.MaxResult"> <summary> <para> <para>Limits results to a maximum number of packages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSPackageCmdlet.NextToken"> <summary> <para> <para>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for 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 the 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.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>Limits results to a maximum number of packages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSPackagesForDomainListCmdlet.NextToken"> <summary> <para> <para>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for 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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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 package versions, along with their creation time and commit message.<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>Returns an audit history of package versions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSPackageVersionHistoryCmdlet.MaxResult"> <summary> <para> <para>Limits results to a maximum number of package versions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSPackageVersionHistoryCmdlet.NextToken"> <summary> <para> <para>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for 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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PackageID parameter. The -PassThru parameter is deprecated, use -Select '^PackageID' instead. This parameter will be removed in a future version. </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> Returns information about reserved OpenSearch instances for this account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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>Set this value to limit the number of results returned. If not specified, defaults to 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSReservedInstanceListCmdlet.NextToken"> <summary> <para> <para>Provides an identifier to allow retrieval of paginated results. </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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReservedInstanceId parameter. The -PassThru parameter is deprecated, use -Select '^ReservedInstanceId' instead. This parameter will be removed in a future version. </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> Lists available reserved OpenSearch instance offerings.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSReservedInstanceOfferingListCmdlet.ReservedInstanceOfferingId"> <summary> <para> <para>The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSReservedInstanceOfferingListCmdlet.MaxResult"> <summary> <para> <para>Set this value to limit the number of results returned. If not specified, defaults to 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSReservedInstanceOfferingListCmdlet.NextToken"> <summary> <para> <para>Provides an identifier to allow retrieval of paginated results. </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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReservedInstanceOfferingId parameter. The -PassThru parameter is deprecated, use -Select '^ReservedInstanceOfferingId' instead. This parameter will be removed in a future version. </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 tags for the given domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSResourceTagCmdlet.ARN"> <summary> <para> <para>Specify the <code>ARN</code> of the domain that the tags you want to view are attached to. </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="P:Amazon.PowerShell.Cmdlets.OS.GetOSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ARN parameter. The -PassThru parameter is deprecated, use -Select '^ARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OS.GetOSUpgradeHistoryCmdlet"> <summary> Retrieves the complete history of the last 10 upgrades performed on the domain.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSUpgradeHistoryCmdlet.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.GetOSUpgradeHistoryCmdlet.MaxResult"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSUpgradeHistoryCmdlet.NextToken"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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> Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSUpgradeStatusCmdlet.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.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="P:Amazon.PowerShell.Cmdlets.OS.GetOSUpgradeStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OS.GetOSVersionListCmdlet"> <summary> List all supported versions of OpenSearch and Elasticsearch.<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> Set this value to limit the number of results returned. Value must be greater than 10 or it won't be honored. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.GetOSVersionListCmdlet.NextToken"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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.NewOSDomainCmdlet"> <summary> Creates a new Amazon OpenSearch Service domain. For more information, see <a href="http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html" target="_blank">Creating and managing Amazon OpenSearch Service domains </a> in the <i>Amazon OpenSearch Service Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AccessPolicy"> <summary> <para> <para>IAM access policy as a JSON-formatted string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AdvancedOption"> <summary> <para> <para>Option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href="http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options" target="_blank">Advanced cluster parameters </a> for more information. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AdvancedSecurityOptions_AnonymousAuthEnabled"> <summary> <para> <para>True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.SnapshotOptions_AutomatedSnapshotStartHour"> <summary> <para> <para>The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is <code>0</code> hours. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ZoneAwarenessConfig_AvailabilityZoneCount"> <summary> <para> <para>An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.DomainEndpointOptions_CustomEndpoint"> <summary> <para> <para>The fully qualified domain for your custom endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.DomainEndpointOptions_CustomEndpointCertificateArn"> <summary> <para> <para>The ACM certificate ARN for your custom endpoint.</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>Total number of dedicated master nodes, active and on standby, for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_DedicatedMasterEnabled"> <summary> <para> <para>A boolean value to indicate whether a dedicated master node is enabled. See <a href="http://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-dedicatedmasternodes" target="_blank">Dedicated master nodes in Amazon OpenSearch Service </a> for more information. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_DedicatedMasterType"> <summary> <para> <para>The instance type for a dedicated master node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AutoTuneOptions_DesiredState"> <summary> <para> <para>The Auto-Tune desired state. Valid values are ENABLED and DISABLED.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.DomainName"> <summary> <para> <para>The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.EBSOptions_EBSEnabled"> <summary> <para> <para>Whether EBS-based storage is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AdvancedSecurityOptions_Enabled"> <summary> <para> <para>True if advanced security is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.SAMLOptions_Enabled"> <summary> <para> <para>True if SAML is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ColdStorageOptions_Enabled"> <summary> <para> <para>Enable cold storage option. Accepted values true or false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.CognitoOptions_Enabled"> <summary> <para> <para>The option to enable Cognito for OpenSearch Dashboards authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.EncryptionAtRestOptions_Enabled"> <summary> <para> <para>The option 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.DomainEndpointOptions_EnforceHTTPS"> <summary> <para> <para>Whether only HTTPS endpoint should be enabled for the domain.</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 Amazon OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see <a href="http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains" target="_blank">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 SAML identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.CognitoOptions_IdentityPoolId"> <summary> <para> <para>The Cognito identity pool ID for OpenSearch Dashboards authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_InstanceCount"> <summary> <para> <para>The number of instances in the specified domain cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_InstanceType"> <summary> <para> <para>The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AdvancedSecurityOptions_InternalUserDatabaseEnabled"> <summary> <para> <para>True if the internal user database is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.EBSOptions_Iops"> <summary> <para> <para>The IOPD for a Provisioned IOPS EBS volume (SSD).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.EncryptionAtRestOptions_KmsKeyId"> <summary> <para> <para>The KMS key ID for encryption at rest options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.LogPublishingOption"> <summary> <para> <para>Map of <code>LogType</code> and <code>LogPublishingOption</code>, each containing options to publish a given type of OpenSearch log. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.AutoTuneOptions_MaintenanceSchedule"> <summary> <para> <para>A list of maintenance schedules. See <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html" target="_blank"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </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>ARN for the master user (if IAM is enabled).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.MasterUserOptions_MasterUserName"> <summary> <para> <para>The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.SAMLOptions_MasterUserName"> <summary> <para> <para>The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.MasterUserOptions_MasterUserPassword"> <summary> <para> <para>The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.</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.CognitoOptions_RoleArn"> <summary> <para> <para>The role ARN that provides OpenSearch permissions for accessing Cognito resources.</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 roles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.VPCOptions_SecurityGroupId"> <summary> <para> <para>The security groups for the VPC endpoint.</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.SAMLOptions_SubjectKey"> <summary> <para> <para>Element of the SAML assertion to use for username. Default is NameID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.VPCOptions_SubnetId"> <summary> <para> <para>The subnets for the VPC endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.TagList"> <summary> <para> <para>A list of <code>Tag</code> added during domain creation. </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. <br /> Can be one of the following values: <ul><li><b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy which supports TLSv1.0 and higher. </li><li><b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy which supports only TLSv1.2 </li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.CognitoOptions_UserPoolId"> <summary> <para> <para>The Cognito user pool ID for OpenSearch Dashboards authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.EBSOptions_VolumeSize"> <summary> <para> <para>Integer to specify the size of an EBS volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.EBSOptions_VolumeType"> <summary> <para> <para>The volume type for EBS-based storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_WarmCount"> <summary> <para> <para>The number of UltraWarm nodes in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_WarmEnabled"> <summary> <para> <para>True to enable UltraWarm storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_WarmType"> <summary> <para> <para>The instance type for the OpenSearch cluster's warm nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSDomainCmdlet.ClusterConfig_ZoneAwarenessEnabled"> <summary> <para> <para>A boolean value to indicate whether zone awareness is enabled. See <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html" target="_blank">Configuring a multi-AZ domain in Amazon OpenSearch Service </a> for more information. </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 connection from a local OpenSearch domain to a remote OpenSearch domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSOutboundConnectionCmdlet.ConnectionAlias"> <summary> <para> <para>The connection alias used used by the customer for this cross-cluster connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSOutboundConnectionCmdlet.LocalDomainInfo_AWSDomainInformation_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.NewOSOutboundConnectionCmdlet.RemoteDomainInfo_AWSDomainInformation_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.NewOSOutboundConnectionCmdlet.LocalDomainInfo_AWSDomainInformation_OwnerId"> <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.NewOSOutboundConnectionCmdlet.RemoteDomainInfo_AWSDomainInformation_OwnerId"> <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.NewOSOutboundConnectionCmdlet.LocalDomainInfo_AWSDomainInformation_Region"> <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.NewOSOutboundConnectionCmdlet.RemoteDomainInfo_AWSDomainInformation_Region"> <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.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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionAlias parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionAlias' instead. This parameter will be removed in a future version. </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> Create a package for use with Amazon OpenSearch Service domains. </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 identifier for the package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.NewOSPackageCmdlet.PackageType"> <summary> <para> <para>Type of package. Currently supports only TXT-DICTIONARY.</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 reserved OpenSearch 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 OpenSearch 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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReservedInstanceOfferingId parameter. The -PassThru parameter is deprecated, use -Select '^ReservedInstanceOfferingId' instead. This parameter will be removed in a future version. </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.RemoveOSDomainCmdlet"> <summary> Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered. </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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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 remote domain owner to delete an existing inbound cross-cluster connection. </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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionId parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionId' instead. This parameter will be removed in a future version. </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 local domain owner to delete an existing outbound cross-cluster connection. </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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionId parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionId' instead. This parameter will be removed in a future version. </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 the package. </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 <code>DescribePackages</code> 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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PackageID parameter. The -PassThru parameter is deprecated, use -Select '^PackageID' instead. This parameter will be removed in a future version. </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 the given domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.RemoveOSResourceTagCmdlet.ARN"> <summary> <para> <para>The <code>ARN</code> 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 <code>TagKey</code> list you want 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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TagKey parameter. The -PassThru parameter is deprecated, use -Select '^TagKey' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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.StartOSAssociatePackageCmdlet"> <summary> Associates a package with an Amazon OpenSearch Service domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSAssociatePackageCmdlet.DomainName"> <summary> <para> <para>The 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 <code>DescribePackages</code> 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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PackageID parameter. The -PassThru parameter is deprecated, use -Select '^PackageID' instead. This parameter will be removed in a future version. </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> Dissociates a package from the Amazon OpenSearch Service domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSDissociatePackageCmdlet.DomainName"> <summary> <para> <para>The name of the domain to associate the package with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StartOSDissociatePackageCmdlet.PackageID"> <summary> <para> <para>The internal ID of the package to associate with a domain. Use <code>DescribePackages</code> 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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PackageID parameter. The -PassThru parameter is deprecated, use -Select '^PackageID' instead. This parameter will be removed in a future version. </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.StartOSServiceSoftwareUpdateCmdlet"> <summary> Schedules a service software update for an Amazon OpenSearch Service domain. </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.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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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.StopOSServiceSoftwareUpdateCmdlet"> <summary> Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the <code>AutomatedUpdateDate</code> and when the <code>UpdateStatus</code> is in the <code>PENDING_UPDATE</code> state. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.StopOSServiceSoftwareUpdateCmdlet.DomainName"> <summary> <para> <para>The name of the domain that you want to stop the latest service software update on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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.UpdateOSDomainCmdlet"> <summary> Allows you to either upgrade your 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> 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.UpdateOSDomainCmdlet.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.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>The version of OpenSearch you intend to upgrade the domain to.</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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TargetVersion parameter. The -PassThru parameter is deprecated, use -Select '^TargetVersion' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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 domain, such as setting the instance type and the number of instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AccessPolicy"> <summary> <para> <para>IAM access policy as a JSON-formatted string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AdvancedOption"> <summary> <para> <para>Modifies the advanced option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href="http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options" target="_blank">Advanced options </a> for more information. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AdvancedSecurityOptions_AnonymousAuthEnabled"> <summary> <para> <para>True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.SnapshotOptions_AutomatedSnapshotStartHour"> <summary> <para> <para>The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is <code>0</code> hours. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ZoneAwarenessConfig_AvailabilityZoneCount"> <summary> <para> <para>An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.DomainEndpointOptions_CustomEndpoint"> <summary> <para> <para>The fully qualified domain for your custom endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.DomainEndpointOptions_CustomEndpointCertificateArn"> <summary> <para> <para>The ACM certificate ARN for your custom endpoint.</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>Total number of dedicated master nodes, active and on standby, for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_DedicatedMasterEnabled"> <summary> <para> <para>A boolean value to indicate whether a dedicated master node is enabled. See <a href="http://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-dedicatedmasternodes" target="_blank">Dedicated master nodes in Amazon OpenSearch Service </a> for more information. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_DedicatedMasterType"> <summary> <para> <para>The instance type for a dedicated master node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AutoTuneOptions_DesiredState"> <summary> <para> <para>The Auto-Tune desired state. Valid values are ENABLED and DISABLED.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.DomainName"> <summary> <para> <para>The name of the domain 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 <code>UpdateDomain</code> request should return the results of validation checks (DryRunResults) without actually applying the change.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.EBSOptions_EBSEnabled"> <summary> <para> <para>Whether EBS-based storage is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AdvancedSecurityOptions_Enabled"> <summary> <para> <para>True if advanced security is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.SAMLOptions_Enabled"> <summary> <para> <para>True if SAML is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ColdStorageOptions_Enabled"> <summary> <para> <para>Enable cold storage option. Accepted values true or false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.CognitoOptions_Enabled"> <summary> <para> <para>The option to enable Cognito for OpenSearch Dashboards authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.EncryptionAtRestOptions_Enabled"> <summary> <para> <para>The option 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.DomainEndpointOptions_EnforceHTTPS"> <summary> <para> <para>Whether only HTTPS endpoint should be enabled for the domain.</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 SAML identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.CognitoOptions_IdentityPoolId"> <summary> <para> <para>The Cognito identity pool ID for OpenSearch Dashboards authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_InstanceCount"> <summary> <para> <para>The number of instances in the specified domain cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_InstanceType"> <summary> <para> <para>The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AdvancedSecurityOptions_InternalUserDatabaseEnabled"> <summary> <para> <para>True if the internal user database is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.EBSOptions_Iops"> <summary> <para> <para>The IOPD for a Provisioned IOPS EBS volume (SSD).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.EncryptionAtRestOptions_KmsKeyId"> <summary> <para> <para>The KMS key ID for encryption at rest options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.LogPublishingOption"> <summary> <para> <para>Map of <code>LogType</code> and <code>LogPublishingOption</code>, each containing options to publish a given type of OpenSearch log. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AutoTuneOptions_MaintenanceSchedule"> <summary> <para> <para>A list of maintenance schedules. See <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html" target="_blank"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </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>ARN for the master user (if IAM is enabled).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.MasterUserOptions_MasterUserName"> <summary> <para> <para>The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.SAMLOptions_MasterUserName"> <summary> <para> <para>The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.MasterUserOptions_MasterUserPassword"> <summary> <para> <para>The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.</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.CognitoOptions_RoleArn"> <summary> <para> <para>The role ARN that provides OpenSearch permissions for accessing Cognito resources.</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 roles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.AutoTuneOptions_RollbackOnDisable"> <summary> <para> <para>The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.VPCOptions_SecurityGroupId"> <summary> <para> <para>The security groups for the VPC endpoint.</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.SAMLOptions_SubjectKey"> <summary> <para> <para>Element of the SAML assertion to use for username. Default is NameID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.VPCOptions_SubnetId"> <summary> <para> <para>The subnets for the VPC endpoint.</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. <br /> Can be one of the following values: <ul><li><b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy which supports TLSv1.0 and higher. </li><li><b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy which supports only TLSv1.2 </li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.CognitoOptions_UserPoolId"> <summary> <para> <para>The Cognito user pool ID for OpenSearch Dashboards authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.EBSOptions_VolumeSize"> <summary> <para> <para>Integer to specify the size of an EBS volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.EBSOptions_VolumeType"> <summary> <para> <para>The volume type for EBS-based storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_WarmCount"> <summary> <para> <para>The number of UltraWarm nodes in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_WarmEnabled"> <summary> <para> <para>True to enable UltraWarm storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_WarmType"> <summary> <para> <para>The instance type for the OpenSearch cluster's warm nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSDomainConfigCmdlet.ClusterConfig_ZoneAwarenessEnabled"> <summary> <para> <para>A boolean value to indicate whether zone awareness is enabled. See <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html" target="_blank">Configuring a multi-AZ domain in Amazon OpenSearch Service </a> for more information. </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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OS.UpdateOSPackageCmdlet.CommitMessage"> <summary> <para> <para>A commit message for the new version which is shown as part of <code>GetPackageVersionHistoryResponse</code>. </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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PackageID parameter. The -PassThru parameter is deprecated, use -Select '^PackageID' instead. This parameter will be removed in a future version. </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> </members> </doc> |