AWS.Tools.ServiceDiscovery.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ServiceDiscovery</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SD.AddSDResourceTagCmdlet"> <summary> Adds one or more tags to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.AddSDResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.AddSDResourceTagCmdlet.Tag"> <summary> <para> <para>The tags to add to the specified resource. Specifying the tag key is required. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.AddSDResourceTagCmdlet.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.ServiceDiscovery.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.AddSDResourceTagCmdlet.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.SD.FindSDInstanceCmdlet"> <summary> Discovers registered instances for a specified namespace and service. You can use <c>DiscoverInstances</c> to discover instances for any type of namespace. <c>DiscoverInstances</c> returns a randomized list of instances allowing customers to distribute traffic evenly across instances. For public and private DNS namespaces, you can also use DNS queries to discover instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.FindSDInstanceCmdlet.HealthStatus"> <summary> <para> <para>The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned.</para><dl><dt>HEALTHY</dt><dd><para>Returns healthy instances.</para></dd><dt>UNHEALTHY</dt><dd><para>Returns unhealthy instances.</para></dd><dt>ALL</dt><dd><para>Returns all instances.</para></dd><dt>HEALTHY_OR_ELSE_ALL</dt><dd><para>Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.FindSDInstanceCmdlet.NamespaceName"> <summary> <para> <para>The <c>HttpName</c> name of the namespace. It's found in the <c>HttpProperties</c> member of the <c>Properties</c> member of the namespace. In most cases, <c>Name</c> and <c>HttpName</c> match. However, if you reuse <c>Name</c> for namespace creation, a generated hash is added to <c>HttpName</c> to distinguish the two.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.FindSDInstanceCmdlet.OptionalParameter"> <summary> <para> <para>Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the <c>QueryParameters</c> parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the <c>QueryParameters</c> parameter are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.FindSDInstanceCmdlet.QueryParameter"> <summary> <para> <para>Filters to scope the results based on custom attributes for the instance (for example, <c>{version=v1, az=1a}</c>). Only instances that match all the specified key-value pairs are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.FindSDInstanceCmdlet.ServiceName"> <summary> <para> <para>The name of the service that you specified when you registered the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.FindSDInstanceCmdlet.MaxResult"> <summary> <para> <para>The maximum number of instances that you want Cloud Map to return in the response to a <c>DiscoverInstances</c> request. If you don't specify a value for <c>MaxResults</c>, Cloud Map returns up to 100 instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.FindSDInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Instances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.DiscoverInstancesResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.DiscoverInstancesResponse 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.SD.GetSDInstanceCmdlet"> <summary> Gets information about a specified instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDInstanceCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance that you want to get information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDInstanceCmdlet.ServiceId"> <summary> <para> <para>The ID of the service that the instance is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Instance'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.GetInstanceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.GetInstanceResponse 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.SD.GetSDInstanceListCmdlet"> <summary> Lists summary information about the instances that you registered by using a specified service.<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.SD.GetSDInstanceListCmdlet.ServiceId"> <summary> <para> <para>The ID of the service that you want to list instances for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDInstanceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of instances that you want Cloud Map to return in the response to a <c>ListInstances</c> request. If you don't specify a value for <c>MaxResults</c>, Cloud Map returns up to 100 instances.</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.SD.GetSDInstanceListCmdlet.NextToken"> <summary> <para> <para>For the first <c>ListInstances</c> request, omit this value.</para><para>If more than <c>MaxResults</c> instances match the specified criteria, you can submit another <c>ListInstances</c> request to get the next group of results. Specify the value of <c>NextToken</c> from the previous response in the next request.</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.SD.GetSDInstanceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Instances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.ListInstancesResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.ListInstancesResponse 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.SD.GetSDInstanceListCmdlet.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.SD.GetSDInstancesHealthStatusCmdlet"> <summary> Gets the current health status (<c>Healthy</c>, <c>Unhealthy</c>, or <c>Unknown</c>) of one or more instances that are associated with a specified service. <note><para> There's a brief delay between when you register an instance and when the health status for the instance is available. </para></note><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.SD.GetSDInstancesHealthStatusCmdlet.Instance"> <summary> <para> <para>An array that contains the IDs of all the instances that you want to get the health status for.</para><para>If you omit <c>Instances</c>, Cloud Map returns the health status for all the instances that are associated with the specified service.</para><note><para>To get the IDs for the instances that you've registered by using a specified service, submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html">ListInstances</a> request.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDInstancesHealthStatusCmdlet.ServiceId"> <summary> <para> <para>The ID of the service that the instance is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDInstancesHealthStatusCmdlet.MaxResult"> <summary> <para> <para>The maximum number of instances that you want Cloud Map to return in the response to a <c>GetInstancesHealthStatus</c> request. If you don't specify a value for <c>MaxResults</c>, Cloud Map returns up to 100 instances.</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.SD.GetSDInstancesHealthStatusCmdlet.NextToken"> <summary> <para> <para>For the first <c>GetInstancesHealthStatus</c> request, omit this value.</para><para>If more than <c>MaxResults</c> instances match the specified criteria, you can submit another <c>GetInstancesHealthStatus</c> request to get the next group of results. Specify the value of <c>NextToken</c> from the previous response in the next request.</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.SD.GetSDInstancesHealthStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.GetInstancesHealthStatusResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.GetInstancesHealthStatusResponse 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.SD.GetSDInstancesHealthStatusCmdlet.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.SD.GetSDInstancesRevisionCmdlet"> <summary> Discovers the increasing revision associated with an instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDInstancesRevisionCmdlet.NamespaceName"> <summary> <para> <para>The <c>HttpName</c> name of the namespace. It's found in the <c>HttpProperties</c> member of the <c>Properties</c> member of the namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDInstancesRevisionCmdlet.ServiceName"> <summary> <para> <para>The name of the service that you specified when you registered the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDInstancesRevisionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InstancesRevision'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.DiscoverInstancesRevisionResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.DiscoverInstancesRevisionResponse 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.SD.GetSDNamespaceCmdlet"> <summary> Gets information about a namespace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDNamespaceCmdlet.Id"> <summary> <para> <para>The ID of the namespace that you want to get information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDNamespaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Namespace'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.GetNamespaceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.GetNamespaceResponse 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.SD.GetSDNamespaceListCmdlet"> <summary> Lists summary information about the namespaces that were created by the current Amazon Web Services 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.SD.GetSDNamespaceListCmdlet.Filter"> <summary> <para> <para>A complex type that contains specifications for the namespaces that you want to list.</para><para>If you specify more than one filter, a namespace must match all filters to be returned by <c>ListNamespaces</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDNamespaceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of namespaces that you want Cloud Map to return in the response to a <c>ListNamespaces</c> request. If you don't specify a value for <c>MaxResults</c>, Cloud Map returns up to 100 namespaces.</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.SD.GetSDNamespaceListCmdlet.NextToken"> <summary> <para> <para>For the first <c>ListNamespaces</c> request, omit this value.</para><para>If the response contains <c>NextToken</c>, submit another <c>ListNamespaces</c> request to get the next group of results. Specify the value of <c>NextToken</c> from the previous response in the next request.</para><note><para>Cloud Map gets <c>MaxResults</c> namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first <c>MaxResults</c> namespaces matched the specified criteria but that subsequent groups of <c>MaxResults</c> namespaces do contain namespaces that match the criteria.</para></note> </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.SD.GetSDNamespaceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Namespaces'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.ListNamespacesResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.ListNamespacesResponse 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.SD.GetSDNamespaceListCmdlet.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.SD.GetSDOperationCmdlet"> <summary> Gets information about any operation that returns an operation ID in the response, such as a <c>CreateHttpNamespace</c> request. <note><para> To get a list of operations that match specified criteria, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html">ListOperations</a>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDOperationCmdlet.OperationId"> <summary> <para> <para>The ID of the operation that you want to get more information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDOperationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Operation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.GetOperationResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.GetOperationResponse 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.SD.GetSDOperationListCmdlet"> <summary> Lists operations that match the criteria that you specify.<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.SD.GetSDOperationListCmdlet.Filter"> <summary> <para> <para>A complex type that contains specifications for the operations that you want to list, for example, operations that you started between a specified start date and end date.</para><para>If you specify more than one filter, an operation must match all filters to be returned by <c>ListOperations</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDOperationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items that you want Cloud Map to return in the response to a <c>ListOperations</c> request. If you don't specify a value for <c>MaxResults</c>, Cloud Map returns up to 100 operations.</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.SD.GetSDOperationListCmdlet.NextToken"> <summary> <para> <para>For the first <c>ListOperations</c> request, omit this value.</para><para>If the response contains <c>NextToken</c>, submit another <c>ListOperations</c> request to get the next group of results. Specify the value of <c>NextToken</c> from the previous response in the next request.</para><note><para>Cloud Map gets <c>MaxResults</c> operations and then filters them based on the specified criteria. It's possible that no operations in the first <c>MaxResults</c> operations matched the specified criteria but that subsequent groups of <c>MaxResults</c> operations do contain operations that match the criteria.</para></note> </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.SD.GetSDOperationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Operations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.ListOperationsResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.ListOperationsResponse 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.SD.GetSDOperationListCmdlet.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.SD.GetSDResourceTagCmdlet"> <summary> Lists tags for the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.ListTagsForResourceResponse 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.SD.GetSDServiceCmdlet"> <summary> Gets the settings for a specified service. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDServiceCmdlet.Id"> <summary> <para> <para>The ID of the service that you want to get settings for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDServiceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Service'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.GetServiceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.GetServiceResponse 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.SD.GetSDServiceListCmdlet"> <summary> Lists summary information for all the services that are associated with one or more namespaces.<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.SD.GetSDServiceListCmdlet.Filter"> <summary> <para> <para>A complex type that contains specifications for the namespaces that you want to list services for. </para><para>If you specify more than one filter, an operation must match all filters to be returned by <c>ListServices</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.GetSDServiceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of services that you want Cloud Map to return in the response to a <c>ListServices</c> request. If you don't specify a value for <c>MaxResults</c>, Cloud Map returns up to 100 services.</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.SD.GetSDServiceListCmdlet.NextToken"> <summary> <para> <para>For the first <c>ListServices</c> request, omit this value.</para><para>If the response contains <c>NextToken</c>, submit another <c>ListServices</c> request to get the next group of results. Specify the value of <c>NextToken</c> from the previous response in the next request.</para><note><para>Cloud Map gets <c>MaxResults</c> services and then filters them based on the specified criteria. It's possible that no services in the first <c>MaxResults</c> services matched the specified criteria but that subsequent groups of <c>MaxResults</c> services do contain services that match the criteria.</para></note> </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.SD.GetSDServiceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Services'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.ListServicesResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.ListServicesResponse 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.SD.GetSDServiceListCmdlet.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.SD.NewSDHttpNamespaceCmdlet"> <summary> Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a <c>DiscoverInstances</c> request but can't be discovered using DNS. <para> For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the <i>Cloud Map Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDHttpNamespaceCmdlet.CreatorRequestId"> <summary> <para> <para>A unique string that identifies the request and that allows failed <c>CreateHttpNamespace</c> requests to be retried without the risk of running the operation twice. <c>CreatorRequestId</c> can be any unique string (for example, a date/time stamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDHttpNamespaceCmdlet.Description"> <summary> <para> <para>A description for the namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDHttpNamespaceCmdlet.Name"> <summary> <para> <para>The name that you want to assign to this namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDHttpNamespaceCmdlet.Tag"> <summary> <para> <para>The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDHttpNamespaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.CreateHttpNamespaceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.CreateHttpNamespaceResponse 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.SD.NewSDHttpNamespaceCmdlet.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.SD.NewSDInstanceRegistrationCmdlet"> <summary> Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a <c>RegisterInstance</c> request, the following occurs: <ul><li><para> For each DNS record that you define in the service that's specified by <c>ServiceId</c>, a record is created or updated in the hosted zone that's associated with the corresponding namespace. </para></li><li><para> If the service includes <c>HealthCheckConfig</c>, a health check is created based on the settings in the health check configuration. </para></li><li><para> The health check, if any, is associated with each of the new or updated records. </para></li></ul><important><para> One <c>RegisterInstance</c> request must complete before you can submit another request and specify the same service ID and instance ID. </para></important><para> For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html">CreateService</a>. </para><para> When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value: </para><ul><li><para><b>If the health check is healthy</b>: returns all the records </para></li><li><para><b>If the health check is unhealthy</b>: returns the applicable value for the last healthy instance </para></li><li><para><b>If you didn't specify a health check configuration</b>: returns all the records </para></li></ul><para> For the current quota on the number of instances that you can register using the same namespace and using the same service, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the <i>Cloud Map Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDInstanceRegistrationCmdlet.Attribute"> <summary> <para> <para>A string map that contains the following information for the service that you specify in <c>ServiceId</c>:</para><ul><li><para>The attributes that apply to the records that are defined in the service. </para></li><li><para>For each attribute, the applicable value.</para></li></ul><important><para>Do not include sensitive information in the attributes if the namespace is discoverable by public DNS queries.</para></important><para>The following are the supported attribute keys.</para><dl><dt>AWS_ALIAS_DNS_NAME</dt><dd><para>If you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that's associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html">AliasTarget</a> in the <i>Route 53 API Reference</i>.</para><para>Note the following:</para><ul><li><para>The configuration for the service that's specified by <c>ServiceId</c> must include settings for an <c>A</c> record, an <c>AAAA</c> record, or both.</para></li><li><para>In the service that's specified by <c>ServiceId</c>, the value of <c>RoutingPolicy</c> must be <c>WEIGHTED</c>.</para></li><li><para>If the service that's specified by <c>ServiceId</c> includes <c>HealthCheckConfig</c> settings, Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the alias record.</para></li><li><para>Cloud Map currently doesn't support creating alias records that route traffic to Amazon Web Services resources other than Elastic Load Balancing load balancers.</para></li><li><para>If you specify a value for <c>AWS_ALIAS_DNS_NAME</c>, don't specify values for any of the <c>AWS_INSTANCE</c> attributes.</para></li><li><para>The <c>AWS_ALIAS_DNS_NAME</c> is not supported in the GovCloud (US) Regions.</para></li></ul></dd><dt>AWS_EC2_INSTANCE_ID</dt><dd><para><i>HTTP namespaces only.</i> The Amazon EC2 instance ID for the instance. If the <c>AWS_EC2_INSTANCE_ID</c> attribute is specified, then the only other attribute that can be specified is <c>AWS_INIT_HEALTH_STATUS</c>. When the <c>AWS_EC2_INSTANCE_ID</c> attribute is specified, then the <c>AWS_INSTANCE_IPV4</c> attribute will be filled out with the primary private IPv4 address.</para></dd><dt>AWS_INIT_HEALTH_STATUS</dt><dd><para>If the service configuration includes <c>HealthCheckCustomConfig</c>, you can optionally use <c>AWS_INIT_HEALTH_STATUS</c> to specify the initial status of the custom health check, <c>HEALTHY</c> or <c>UNHEALTHY</c>. If you don't specify a value for <c>AWS_INIT_HEALTH_STATUS</c>, the initial status is <c>HEALTHY</c>.</para></dd><dt>AWS_INSTANCE_CNAME</dt><dd><para>If the service configuration includes a <c>CNAME</c> record, the domain name that you want Route 53 to return in response to DNS queries (for example, <c>example.com</c>).</para><para>This value is required if the service specified by <c>ServiceId</c> includes settings for an <c>CNAME</c> record.</para></dd><dt>AWS_INSTANCE_IPV4</dt><dd><para>If the service configuration includes an <c>A</c> record, the IPv4 address that you want Route 53 to return in response to DNS queries (for example, <c>192.0.2.44</c>).</para><para>This value is required if the service specified by <c>ServiceId</c> includes settings for an <c>A</c> record. If the service includes settings for an <c>SRV</c> record, you must specify a value for <c>AWS_INSTANCE_IPV4</c>, <c>AWS_INSTANCE_IPV6</c>, or both.</para></dd><dt>AWS_INSTANCE_IPV6</dt><dd><para>If the service configuration includes an <c>AAAA</c> record, the IPv6 address that you want Route 53 to return in response to DNS queries (for example, <c>2001:0db8:85a3:0000:0000:abcd:0001:2345</c>).</para><para>This value is required if the service specified by <c>ServiceId</c> includes settings for an <c>AAAA</c> record. If the service includes settings for an <c>SRV</c> record, you must specify a value for <c>AWS_INSTANCE_IPV4</c>, <c>AWS_INSTANCE_IPV6</c>, or both.</para></dd><dt>AWS_INSTANCE_PORT</dt><dd><para>If the service includes an <c>SRV</c> record, the value that you want Route 53 to return for the port.</para><para>If the service includes <c>HealthCheckConfig</c>, the port on the endpoint that you want Route 53 to send requests to. </para><para>This value is required if you specified settings for an <c>SRV</c> record or a Route 53 health check when you created the service.</para></dd><dt>Custom attributes</dt><dd><para>You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of all provided attributes (sum of all keys and values) must not exceed 5,000 characters.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDInstanceRegistrationCmdlet.CreatorRequestId"> <summary> <para> <para>A unique string that identifies the request and that allows failed <c>RegisterInstance</c> requests to be retried without the risk of executing the operation twice. You must use a unique <c>CreatorRequestId</c> string every time you submit a <c>RegisterInstance</c> request if you're registering additional instances for the same namespace and service. <c>CreatorRequestId</c> can be any unique string (for example, a date/time stamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDInstanceRegistrationCmdlet.InstanceId"> <summary> <para> <para>An identifier that you want to associate with the instance. Note the following:</para><ul><li><para>If the service that's specified by <c>ServiceId</c> includes settings for an <c>SRV</c> record, the value of <c>InstanceId</c> is automatically included as part of the value for the <c>SRV</c> record. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type">DnsRecord > Type</a>.</para></li><li><para>You can use this value to update an existing instance.</para></li><li><para>To register a new instance, you must specify a value that's unique among instances that you register by using the same service. </para></li><li><para>If you specify an existing <c>InstanceId</c> and <c>ServiceId</c>, Cloud Map updates the existing DNS records, if any. If there's also an existing health check, Cloud Map deletes the old health check and creates a new one. </para><note><para>The health check isn't deleted immediately, so it will still appear for a while if you submit a <c>ListHealthChecks</c> request, for example.</para></note></li></ul><note><para>Do not include sensitive information in <c>InstanceId</c> if the namespace is discoverable by public DNS queries and any <c>Type</c> member of <c>DnsRecord</c> for the service contains <c>SRV</c> because the <c>InstanceId</c> is discoverable by public DNS queries.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDInstanceRegistrationCmdlet.ServiceId"> <summary> <para> <para>The ID of the service that you want to use for settings for the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDInstanceRegistrationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.RegisterInstanceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.RegisterInstanceResponse 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.SD.NewSDInstanceRegistrationCmdlet.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.SD.NewSDPrivateDnsNamespaceCmdlet"> <summary> Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace <c>example.com</c> and name your service <c>backend</c>, the resulting DNS name for the service is <c>backend.example.com</c>. Service instances that are registered using a private DNS namespace can be discovered using either a <c>DiscoverInstances</c> request or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the <i>Cloud Map Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDPrivateDnsNamespaceCmdlet.CreatorRequestId"> <summary> <para> <para>A unique string that identifies the request and that allows failed <c>CreatePrivateDnsNamespace</c> requests to be retried without the risk of running the operation twice. <c>CreatorRequestId</c> can be any unique string (for example, a date/timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDPrivateDnsNamespaceCmdlet.Description"> <summary> <para> <para>A description for the namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDPrivateDnsNamespaceCmdlet.Name"> <summary> <para> <para>The name that you want to assign to this namespace. When you create a private DNS namespace, Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDPrivateDnsNamespaceCmdlet.Tag"> <summary> <para> <para>The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDPrivateDnsNamespaceCmdlet.SOA_TTL"> <summary> <para> <para>The time to live (TTL) for purposes of negative caching.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDPrivateDnsNamespaceCmdlet.Vpc"> <summary> <para> <para>The ID of the Amazon VPC that you want to associate the namespace with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDPrivateDnsNamespaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.CreatePrivateDnsNamespaceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.CreatePrivateDnsNamespaceResponse 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.SD.NewSDPrivateDnsNamespaceCmdlet.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.SD.NewSDPublicDnsNamespaceCmdlet"> <summary> Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace <c>example.com</c> and name your service <c>backend</c>, the resulting DNS name for the service is <c>backend.example.com</c>. You can discover instances that were registered with a public DNS namespace by using either a <c>DiscoverInstances</c> request or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the <i>Cloud Map Developer Guide</i>. <important><para> The <c>CreatePublicDnsNamespace</c> API operation is not supported in the Amazon Web Services GovCloud (US) Regions. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDPublicDnsNamespaceCmdlet.CreatorRequestId"> <summary> <para> <para>A unique string that identifies the request and that allows failed <c>CreatePublicDnsNamespace</c> requests to be retried without the risk of running the operation twice. <c>CreatorRequestId</c> can be any unique string (for example, a date/timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDPublicDnsNamespaceCmdlet.Description"> <summary> <para> <para>A description for the namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDPublicDnsNamespaceCmdlet.Name"> <summary> <para> <para>The name that you want to assign to this namespace.</para><note><para>Do not include sensitive information in the name. The name is publicly available using DNS queries.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDPublicDnsNamespaceCmdlet.Tag"> <summary> <para> <para>The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDPublicDnsNamespaceCmdlet.SOA_TTL"> <summary> <para> <para>The time to live (TTL) for purposes of negative caching.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDPublicDnsNamespaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.CreatePublicDnsNamespaceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.CreatePublicDnsNamespaceResponse 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.SD.NewSDPublicDnsNamespaceCmdlet.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.SD.NewSDServiceCmdlet"> <summary> Creates a service. This action defines the configuration for the following entities: <ul><li><para> For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53: </para><ul><li><para><c>A</c></para></li><li><para><c>AAAA</c></para></li><li><para><c>A</c> and <c>AAAA</c></para></li><li><para><c>SRV</c></para></li><li><para><c>CNAME</c></para></li></ul></li><li><para> Optionally, a health check </para></li></ul><para> After you create the service, you can submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request, and Cloud Map uses the values in the configuration to create the specified entities. </para><para> For the current quota on the number of instances that you can register using the same namespace and using the same service, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the <i>Cloud Map Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDServiceCmdlet.CreatorRequestId"> <summary> <para> <para>A unique string that identifies the request and that allows failed <c>CreateService</c> requests to be retried without the risk of running the operation twice. <c>CreatorRequestId</c> can be any unique string (for example, a date/timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDServiceCmdlet.Description"> <summary> <para> <para>A description for the service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDServiceCmdlet.DnsConfig"> <summary> <para> <para>A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDServiceCmdlet.HealthCheckConfig_FailureThreshold"> <summary> <para> <para>The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or the other way around. For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How Route 53 Determines Whether an Endpoint Is Healthy</a> in the <i>Route 53 Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDServiceCmdlet.HealthCheckCustomConfig"> <summary> <para> <para>A complex type that contains information about an optional custom health check.</para><important><para>If you specify a health check configuration, you can specify either <c>HealthCheckCustomConfig</c> or <c>HealthCheckConfig</c> but not both.</para></important><para>You can't add, update, or delete a <c>HealthCheckCustomConfig</c> configuration from an existing service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDServiceCmdlet.Name"> <summary> <para> <para>The name that you want to assign to the service.</para><note><para>Do not include sensitive information in the name if the namespace is discoverable by public DNS queries.</para></note><para>If you want Cloud Map to create an <c>SRV</c> record when you register an instance and you're using a system that requires a specific <c>SRV</c> format, such as <a href="http://www.haproxy.org/">HAProxy</a>, specify the following for <c>Name</c>:</para><ul><li><para>Start the name with an underscore (_), such as <c>_exampleservice</c>.</para></li><li><para>End the name with <i>._protocol</i>, such as <c>._tcp</c>.</para></li></ul><para>When you register an instance, Cloud Map creates an <c>SRV</c> record and assigns a name to the record by concatenating the service name and the namespace name (for example,</para><para><c>_exampleservice._tcp.example.com</c>).</para><note><para>For services that are accessible by DNS queries, you can't create multiple services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services that with names that differ only by case.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDServiceCmdlet.NamespaceId"> <summary> <para> <para>The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it can be specified either here or in the <c>DnsConfig</c> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDServiceCmdlet.HealthCheckConfig_ResourcePath"> <summary> <para> <para>The path that you want Route 53 to request when performing health checks. The path can be any value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is <c>/docs/route53-health-check.html</c>. Route 53 automatically adds the DNS name for the service. If you don't specify a value for <c>ResourcePath</c>, the default value is <c>/</c>.</para><para>If you specify <c>TCP</c> for <c>Type</c>, you must <i>not</i> specify a value for <c>ResourcePath</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDServiceCmdlet.Tag"> <summary> <para> <para>The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDServiceCmdlet.HealthCheckConfig_Type"> <summary> <para> <para>The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.</para><important><para>You can't change the value of <c>Type</c> after you create a health check.</para></important><para>You can create the following types of health checks:</para><ul><li><para><b>HTTP</b>: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.</para></li><li><para><b>HTTPS</b>: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.</para><important><para>If you specify HTTPS for the value of <c>Type</c>, the endpoint must support TLS v1.0 or later.</para></important></li><li><para><b>TCP</b>: Route 53 tries to establish a TCP connection.</para><para>If you specify <c>TCP</c> for <c>Type</c>, don't specify a value for <c>ResourcePath</c>.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How Route 53 Determines Whether an Endpoint Is Healthy</a> in the <i>Route 53 Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDServiceCmdlet.Type"> <summary> <para> <para>If present, specifies that the service instances are only discoverable using the <c>DiscoverInstances</c> API operation. No DNS records is registered for the service instances. The only valid value is <c>HTTP</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.NewSDServiceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Service'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.CreateServiceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.CreateServiceResponse 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.SD.NewSDServiceCmdlet.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.SD.RemoveSDInstanceRegistrationCmdlet"> <summary> Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.RemoveSDInstanceRegistrationCmdlet.InstanceId"> <summary> <para> <para>The value that you specified for <c>Id</c> in the <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.RemoveSDInstanceRegistrationCmdlet.ServiceId"> <summary> <para> <para>The ID of the service that the instance is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.RemoveSDInstanceRegistrationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.DeregisterInstanceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.DeregisterInstanceResponse 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.SD.RemoveSDInstanceRegistrationCmdlet.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.SD.RemoveSDNamespaceCmdlet"> <summary> Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.RemoveSDNamespaceCmdlet.Id"> <summary> <para> <para>The ID of the namespace that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.RemoveSDNamespaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.DeleteNamespaceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.DeleteNamespaceResponse 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.SD.RemoveSDNamespaceCmdlet.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.SD.RemoveSDResourceTagCmdlet"> <summary> Removes one or more tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.RemoveSDResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.RemoveSDResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys to remove from the specified resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.RemoveSDResourceTagCmdlet.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.ServiceDiscovery.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.RemoveSDResourceTagCmdlet.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.SD.RemoveSDServiceCmdlet"> <summary> Deletes a specified service. If the service still contains one or more registered instances, the request fails. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.RemoveSDServiceCmdlet.Id"> <summary> <para> <para>The ID of the service that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.RemoveSDServiceCmdlet.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.ServiceDiscovery.Model.DeleteServiceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.RemoveSDServiceCmdlet.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.SD.UpdateSDHttpNamespaceCmdlet"> <summary> Updates an HTTP namespace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDHttpNamespaceCmdlet.Namespace_Description"> <summary> <para> <para>An updated description for the HTTP namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDHttpNamespaceCmdlet.Id"> <summary> <para> <para>The ID of the namespace that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDHttpNamespaceCmdlet.UpdaterRequestId"> <summary> <para> <para>A unique string that identifies the request and that allows failed <c>UpdateHttpNamespace</c> requests to be retried without the risk of running the operation twice. <c>UpdaterRequestId</c> can be any unique string (for example, a date/timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDHttpNamespaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.UpdateHttpNamespaceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.UpdateHttpNamespaceResponse 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.SD.UpdateSDHttpNamespaceCmdlet.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.SD.UpdateSDInstanceCustomHealthStatusCmdlet"> <summary> Submits a request to change the health status of a custom health check to healthy or unhealthy. <para> You can use <c>UpdateInstanceCustomHealthStatus</c> to change the status only for custom health checks, which you define using <c>HealthCheckCustomConfig</c> when you create a service. You can't use it to change the status for Route 53 health checks, which you define using <c>HealthCheckConfig</c>. </para><para> For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html">HealthCheckCustomConfig</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDInstanceCustomHealthStatusCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance that you want to change the health status for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDInstanceCustomHealthStatusCmdlet.ServiceId"> <summary> <para> <para>The ID of the service that includes the configuration for the custom health check that you want to change the status for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDInstanceCustomHealthStatusCmdlet.Status"> <summary> <para> <para>The new status of the instance, <c>HEALTHY</c> or <c>UNHEALTHY</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDInstanceCustomHealthStatusCmdlet.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.ServiceDiscovery.Model.UpdateInstanceCustomHealthStatusResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDInstanceCustomHealthStatusCmdlet.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.SD.UpdateSDPrivateDnsNamespaceCmdlet"> <summary> Updates a private DNS namespace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDPrivateDnsNamespaceCmdlet.Namespace_Description"> <summary> <para> <para>An updated description for the private DNS namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDPrivateDnsNamespaceCmdlet.Id"> <summary> <para> <para>The ID of the namespace that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDPrivateDnsNamespaceCmdlet.SOA_TTL"> <summary> <para> <para>The updated time to live (TTL) for purposes of negative caching.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDPrivateDnsNamespaceCmdlet.UpdaterRequestId"> <summary> <para> <para>A unique string that identifies the request and that allows failed <c>UpdatePrivateDnsNamespace</c> requests to be retried without the risk of running the operation twice. <c>UpdaterRequestId</c> can be any unique string (for example, a date/timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDPrivateDnsNamespaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.UpdatePrivateDnsNamespaceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.UpdatePrivateDnsNamespaceResponse 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.SD.UpdateSDPrivateDnsNamespaceCmdlet.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.SD.UpdateSDPublicDnsNamespaceCmdlet"> <summary> Updates a public DNS namespace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDPublicDnsNamespaceCmdlet.Namespace_Description"> <summary> <para> <para>An updated description for the public DNS namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDPublicDnsNamespaceCmdlet.Id"> <summary> <para> <para>The ID of the namespace being updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDPublicDnsNamespaceCmdlet.SOA_TTL"> <summary> <para> <para>The updated time to live (TTL) for purposes of negative caching.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDPublicDnsNamespaceCmdlet.UpdaterRequestId"> <summary> <para> <para>A unique string that identifies the request and that allows failed <c>UpdatePublicDnsNamespace</c> requests to be retried without the risk of running the operation twice. <c>UpdaterRequestId</c> can be any unique string (for example, a date/timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDPublicDnsNamespaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.UpdatePublicDnsNamespaceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.UpdatePublicDnsNamespaceResponse 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.SD.UpdateSDPublicDnsNamespaceCmdlet.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.SD.UpdateSDServiceCmdlet"> <summary> Submits a request to perform the following operations: <ul><li><para> Update the TTL setting for existing <c>DnsRecords</c> configurations </para></li><li><para> Add, update, or delete <c>HealthCheckConfig</c> for a specified service </para><note><para> You can't add, update, or delete a <c>HealthCheckCustomConfig</c> configuration. </para></note></li></ul><para> For public and private DNS namespaces, note the following: </para><ul><li><para> If you omit any existing <c>DnsRecords</c> or <c>HealthCheckConfig</c> configurations from an <c>UpdateService</c> request, the configurations are deleted from the service. </para></li><li><para> If you omit an existing <c>HealthCheckCustomConfig</c> configuration from an <c>UpdateService</c> request, the configuration isn't deleted from the service. </para></li></ul><para> When you update settings for a service, Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDServiceCmdlet.Id"> <summary> <para> <para>The ID of the service that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDServiceCmdlet.Service"> <summary> <para> <para>A complex type that contains the new settings for the service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SD.UpdateSDServiceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.UpdateServiceResponse). Specifying the name of a property of type Amazon.ServiceDiscovery.Model.UpdateServiceResponse 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.SD.UpdateSDServiceCmdlet.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> |