Struct aws_sdk_servicediscovery::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS Cloud Map
Client for invoking operations on AWS Cloud Map. Each operation on AWS Cloud Map is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_servicediscovery::Client::new(&config);
Occasionally, SDKs may have additional service-specific that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_servicediscovery::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CreateHttpNamespace
operation has
a Client::create_http_namespace
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.create_http_namespace()
.name("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn create_http_namespace(&self) -> CreateHttpNamespaceFluentBuilder
pub fn create_http_namespace(&self) -> CreateHttpNamespaceFluentBuilder
Constructs a fluent builder for the CreateHttpNamespace
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name that you want to assign to this namespace.
creator_request_id(impl Into<String>)
/set_creator_request_id(Option<String>)
:A unique string that identifies the request and that allows failed
CreateHttpNamespace
requests to be retried without the risk of running the operation twice.CreatorRequestId
can be any unique string (for example, a date/time stamp).description(impl Into<String>)
/set_description(Option<String>)
:A description for the namespace.
tags(Tag)
/set_tags(Option<Vec<Tag>>)
: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.
- On success, responds with
CreateHttpNamespaceOutput
with field(s):operation_id(Option<String>)
:A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
- On failure, responds with
SdkError<CreateHttpNamespaceError>
source§impl Client
impl Client
sourcepub fn create_private_dns_namespace(
&self
) -> CreatePrivateDnsNamespaceFluentBuilder
pub fn create_private_dns_namespace( &self ) -> CreatePrivateDnsNamespaceFluentBuilder
Constructs a fluent builder for the CreatePrivateDnsNamespace
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
: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.
creator_request_id(impl Into<String>)
/set_creator_request_id(Option<String>)
:A unique string that identifies the request and that allows failed
CreatePrivateDnsNamespace
requests to be retried without the risk of running the operation twice.CreatorRequestId
can be any unique string (for example, a date/timestamp).description(impl Into<String>)
/set_description(Option<String>)
:A description for the namespace.
vpc(impl Into<String>)
/set_vpc(Option<String>)
:The ID of the Amazon VPC that you want to associate the namespace with.
tags(Tag)
/set_tags(Option<Vec<Tag>>)
: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.
properties(PrivateDnsNamespaceProperties)
/set_properties(Option<PrivateDnsNamespaceProperties>)
:Properties for the private DNS namespace.
- On success, responds with
CreatePrivateDnsNamespaceOutput
with field(s):operation_id(Option<String>)
:A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
- On failure, responds with
SdkError<CreatePrivateDnsNamespaceError>
source§impl Client
impl Client
sourcepub fn create_public_dns_namespace(
&self
) -> CreatePublicDnsNamespaceFluentBuilder
pub fn create_public_dns_namespace( &self ) -> CreatePublicDnsNamespaceFluentBuilder
Constructs a fluent builder for the CreatePublicDnsNamespace
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name that you want to assign to this namespace.
Do not include sensitive information in the name. The name is publicly available using DNS queries.
creator_request_id(impl Into<String>)
/set_creator_request_id(Option<String>)
:A unique string that identifies the request and that allows failed
CreatePublicDnsNamespace
requests to be retried without the risk of running the operation twice.CreatorRequestId
can be any unique string (for example, a date/timestamp).description(impl Into<String>)
/set_description(Option<String>)
:A description for the namespace.
tags(Tag)
/set_tags(Option<Vec<Tag>>)
: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.
properties(PublicDnsNamespaceProperties)
/set_properties(Option<PublicDnsNamespaceProperties>)
:Properties for the public DNS namespace.
- On success, responds with
CreatePublicDnsNamespaceOutput
with field(s):operation_id(Option<String>)
:A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
- On failure, responds with
SdkError<CreatePublicDnsNamespaceError>
source§impl Client
impl Client
sourcepub fn create_service(&self) -> CreateServiceFluentBuilder
pub fn create_service(&self) -> CreateServiceFluentBuilder
Constructs a fluent builder for the CreateService
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name that you want to assign to the service.
Do not include sensitive information in the name if the namespace is discoverable by public DNS queries.
If you want Cloud Map to create an
SRV
record when you register an instance and you’re using a system that requires a specificSRV
format, such as HAProxy, specify the following forName
:-
Start the name with an underscore (_), such as
_exampleservice
. -
End the name with ._protocol, such as
._tcp
.
When you register an instance, Cloud Map creates an
SRV
record and assigns a name to the record by concatenating the service name and the namespace name (for example,_exampleservice._tcp.example.com
).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.
-
namespace_id(impl Into<String>)
/set_namespace_id(Option<String>)
: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
DnsConfig
object.creator_request_id(impl Into<String>)
/set_creator_request_id(Option<String>)
:A unique string that identifies the request and that allows failed
CreateService
requests to be retried without the risk of running the operation twice.CreatorRequestId
can be any unique string (for example, a date/timestamp).description(impl Into<String>)
/set_description(Option<String>)
:A description for the service.
dns_config(DnsConfig)
/set_dns_config(Option<DnsConfig>)
:A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance.
health_check_config(HealthCheckConfig)
/set_health_check_config(Option<HealthCheckConfig>)
:Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check with all the Route 53 DNS records that you specify in
DnsConfig
.If you specify a health check configuration, you can specify either
HealthCheckCustomConfig
orHealthCheckConfig
but not both.For information about the charges for health checks, see Cloud Map Pricing.
health_check_custom_config(HealthCheckCustomConfig)
/set_health_check_custom_config(Option<HealthCheckCustomConfig>)
:A complex type that contains information about an optional custom health check.
If you specify a health check configuration, you can specify either
HealthCheckCustomConfig
orHealthCheckConfig
but not both.You can’t add, update, or delete a
HealthCheckCustomConfig
configuration from an existing service.tags(Tag)
/set_tags(Option<Vec<Tag>>)
: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.
r#type(ServiceTypeOption)
/set_type(Option<ServiceTypeOption>)
:If present, specifies that the service instances are only discoverable using the
DiscoverInstances
API operation. No DNS records is registered for the service instances. The only valid value isHTTP
.
- On success, responds with
CreateServiceOutput
with field(s):service(Option<Service>)
:A complex type that contains information about the new service.
- On failure, responds with
SdkError<CreateServiceError>
source§impl Client
impl Client
sourcepub fn delete_namespace(&self) -> DeleteNamespaceFluentBuilder
pub fn delete_namespace(&self) -> DeleteNamespaceFluentBuilder
Constructs a fluent builder for the DeleteNamespace
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the namespace that you want to delete.
- On success, responds with
DeleteNamespaceOutput
with field(s):operation_id(Option<String>)
:A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
- On failure, responds with
SdkError<DeleteNamespaceError>
source§impl Client
impl Client
sourcepub fn delete_service(&self) -> DeleteServiceFluentBuilder
pub fn delete_service(&self) -> DeleteServiceFluentBuilder
Constructs a fluent builder for the DeleteService
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the service that you want to delete.
- On success, responds with
DeleteServiceOutput
- On failure, responds with
SdkError<DeleteServiceError>
source§impl Client
impl Client
sourcepub fn deregister_instance(&self) -> DeregisterInstanceFluentBuilder
pub fn deregister_instance(&self) -> DeregisterInstanceFluentBuilder
Constructs a fluent builder for the DeregisterInstance
operation.
- The fluent builder is configurable:
service_id(impl Into<String>)
/set_service_id(Option<String>)
:The ID of the service that the instance is associated with.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The value that you specified for
Id
in the RegisterInstance request.
- On success, responds with
DeregisterInstanceOutput
with field(s):operation_id(Option<String>)
:A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
- On failure, responds with
SdkError<DeregisterInstanceError>
source§impl Client
impl Client
sourcepub fn discover_instances(&self) -> DiscoverInstancesFluentBuilder
pub fn discover_instances(&self) -> DiscoverInstancesFluentBuilder
Constructs a fluent builder for the DiscoverInstances
operation.
- The fluent builder is configurable:
namespace_name(impl Into<String>)
/set_namespace_name(Option<String>)
:The
HttpName
name of the namespace. It’s found in theHttpProperties
member of theProperties
member of the namespace.service_name(impl Into<String>)
/set_service_name(Option<String>)
:The name of the service that you specified when you registered the instance.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of instances that you want Cloud Map to return in the response to a
DiscoverInstances
request. If you don’t specify a value forMaxResults
, Cloud Map returns up to 100 instances.query_parameters(impl Into<String>, impl Into<String>)
/set_query_parameters(Option<HashMap<String, String>>)
:Filters to scope the results based on custom attributes for the instance (for example,
{version=v1, az=1a}
). Only instances that match all the specified key-value pairs are returned.optional_parameters(impl Into<String>, impl Into<String>)
/set_optional_parameters(Option<HashMap<String, String>>)
:Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the
QueryParameters
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 theQueryParameters
parameter are returned.health_status(HealthStatusFilter)
/set_health_status(Option<HealthStatusFilter>)
: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.
- HEALTHY
-
Returns healthy instances.
- UNHEALTHY
-
Returns unhealthy instances.
- ALL
-
Returns all instances.
- HEALTHY_OR_ELSE_ALL
-
Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.
- On success, responds with
DiscoverInstancesOutput
with field(s):instances(Option<Vec<HttpInstanceSummary>>)
:A complex type that contains one
HttpInstanceSummary
for each registered instance.
- On failure, responds with
SdkError<DiscoverInstancesError>
source§impl Client
impl Client
sourcepub fn get_instance(&self) -> GetInstanceFluentBuilder
pub fn get_instance(&self) -> GetInstanceFluentBuilder
Constructs a fluent builder for the GetInstance
operation.
- The fluent builder is configurable:
service_id(impl Into<String>)
/set_service_id(Option<String>)
:The ID of the service that the instance is associated with.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The ID of the instance that you want to get information about.
- On success, responds with
GetInstanceOutput
with field(s):instance(Option<Instance>)
:A complex type that contains information about a specified instance.
- On failure, responds with
SdkError<GetInstanceError>
source§impl Client
impl Client
sourcepub fn get_instances_health_status(
&self
) -> GetInstancesHealthStatusFluentBuilder
pub fn get_instances_health_status( &self ) -> GetInstancesHealthStatusFluentBuilder
Constructs a fluent builder for the GetInstancesHealthStatus
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
service_id(impl Into<String>)
/set_service_id(Option<String>)
:The ID of the service that the instance is associated with.
instances(impl Into<String>)
/set_instances(Option<Vec<String>>)
:An array that contains the IDs of all the instances that you want to get the health status for.
If you omit
Instances
, Cloud Map returns the health status for all the instances that are associated with the specified service.To get the IDs for the instances that you’ve registered by using a specified service, submit a ListInstances request.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of instances that you want Cloud Map to return in the response to a
GetInstancesHealthStatus
request. If you don’t specify a value forMaxResults
, Cloud Map returns up to 100 instances.next_token(impl Into<String>)
/set_next_token(Option<String>)
:For the first
GetInstancesHealthStatus
request, omit this value.If more than
MaxResults
instances match the specified criteria, you can submit anotherGetInstancesHealthStatus
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.
- On success, responds with
GetInstancesHealthStatusOutput
with field(s):status(Option<HashMap<String, HealthStatus>>)
:A complex type that contains the IDs and the health status of the instances that you specified in the
GetInstancesHealthStatus
request.next_token(Option<String>)
:If more than
MaxResults
instances match the specified criteria, you can submit anotherGetInstancesHealthStatus
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.
- On failure, responds with
SdkError<GetInstancesHealthStatusError>
source§impl Client
impl Client
sourcepub fn get_namespace(&self) -> GetNamespaceFluentBuilder
pub fn get_namespace(&self) -> GetNamespaceFluentBuilder
Constructs a fluent builder for the GetNamespace
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the namespace that you want to get information about.
- On success, responds with
GetNamespaceOutput
with field(s):namespace(Option<Namespace>)
:A complex type that contains information about the specified namespace.
- On failure, responds with
SdkError<GetNamespaceError>
source§impl Client
impl Client
sourcepub fn get_operation(&self) -> GetOperationFluentBuilder
pub fn get_operation(&self) -> GetOperationFluentBuilder
Constructs a fluent builder for the GetOperation
operation.
- The fluent builder is configurable:
operation_id(impl Into<String>)
/set_operation_id(Option<String>)
:The ID of the operation that you want to get more information about.
- On success, responds with
GetOperationOutput
with field(s):operation(Option<Operation>)
:A complex type that contains information about the operation.
- On failure, responds with
SdkError<GetOperationError>
source§impl Client
impl Client
sourcepub fn get_service(&self) -> GetServiceFluentBuilder
pub fn get_service(&self) -> GetServiceFluentBuilder
Constructs a fluent builder for the GetService
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the service that you want to get settings for.
- On success, responds with
GetServiceOutput
with field(s):service(Option<Service>)
:A complex type that contains information about the service.
- On failure, responds with
SdkError<GetServiceError>
source§impl Client
impl Client
sourcepub fn list_instances(&self) -> ListInstancesFluentBuilder
pub fn list_instances(&self) -> ListInstancesFluentBuilder
Constructs a fluent builder for the ListInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
service_id(impl Into<String>)
/set_service_id(Option<String>)
:The ID of the service that you want to list instances for.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:For the first
ListInstances
request, omit this value.If more than
MaxResults
instances match the specified criteria, you can submit anotherListInstances
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of instances that you want Cloud Map to return in the response to a
ListInstances
request. If you don’t specify a value forMaxResults
, Cloud Map returns up to 100 instances.
- On success, responds with
ListInstancesOutput
with field(s):instances(Option<Vec<InstanceSummary>>)
:Summary information about the instances that are associated with the specified service.
next_token(Option<String>)
:If more than
MaxResults
instances match the specified criteria, you can submit anotherListInstances
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.
- On failure, responds with
SdkError<ListInstancesError>
source§impl Client
impl Client
sourcepub fn list_namespaces(&self) -> ListNamespacesFluentBuilder
pub fn list_namespaces(&self) -> ListNamespacesFluentBuilder
Constructs a fluent builder for the ListNamespaces
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:For the first
ListNamespaces
request, omit this value.If the response contains
NextToken
, submit anotherListNamespaces
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Cloud Map gets
MaxResults
namespaces and then filters them based on the specified criteria. It’s possible that no namespaces in the firstMaxResults
namespaces matched the specified criteria but that subsequent groups ofMaxResults
namespaces do contain namespaces that match the criteria.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of namespaces that you want Cloud Map to return in the response to a
ListNamespaces
request. If you don’t specify a value forMaxResults
, Cloud Map returns up to 100 namespaces.filters(NamespaceFilter)
/set_filters(Option<Vec<NamespaceFilter>>)
:A complex type that contains specifications for the namespaces that you want to list.
If you specify more than one filter, a namespace must match all filters to be returned by
ListNamespaces
.
- On success, responds with
ListNamespacesOutput
with field(s):namespaces(Option<Vec<NamespaceSummary>>)
:An array that contains one
NamespaceSummary
object for each namespace that matches the specified filter criteria.next_token(Option<String>)
:If the response contains
NextToken
, submit anotherListNamespaces
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Cloud Map gets
MaxResults
namespaces and then filters them based on the specified criteria. It’s possible that no namespaces in the firstMaxResults
namespaces matched the specified criteria but that subsequent groups ofMaxResults
namespaces do contain namespaces that match the criteria.
- On failure, responds with
SdkError<ListNamespacesError>
source§impl Client
impl Client
sourcepub fn list_operations(&self) -> ListOperationsFluentBuilder
pub fn list_operations(&self) -> ListOperationsFluentBuilder
Constructs a fluent builder for the ListOperations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:For the first
ListOperations
request, omit this value.If the response contains
NextToken
, submit anotherListOperations
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Cloud Map gets
MaxResults
operations and then filters them based on the specified criteria. It’s possible that no operations in the firstMaxResults
operations matched the specified criteria but that subsequent groups ofMaxResults
operations do contain operations that match the criteria.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of items that you want Cloud Map to return in the response to a
ListOperations
request. If you don’t specify a value forMaxResults
, Cloud Map returns up to 100 operations.filters(OperationFilter)
/set_filters(Option<Vec<OperationFilter>>)
: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.
If you specify more than one filter, an operation must match all filters to be returned by
ListOperations
.
- On success, responds with
ListOperationsOutput
with field(s):operations(Option<Vec<OperationSummary>>)
:Summary information about the operations that match the specified criteria.
next_token(Option<String>)
:If the response contains
NextToken
, submit anotherListOperations
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Cloud Map gets
MaxResults
operations and then filters them based on the specified criteria. It’s possible that no operations in the firstMaxResults
operations matched the specified criteria but that subsequent groups ofMaxResults
operations do contain operations that match the criteria.
- On failure, responds with
SdkError<ListOperationsError>
source§impl Client
impl Client
sourcepub fn list_services(&self) -> ListServicesFluentBuilder
pub fn list_services(&self) -> ListServicesFluentBuilder
Constructs a fluent builder for the ListServices
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:For the first
ListServices
request, omit this value.If the response contains
NextToken
, submit anotherListServices
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Cloud Map gets
MaxResults
services and then filters them based on the specified criteria. It’s possible that no services in the firstMaxResults
services matched the specified criteria but that subsequent groups ofMaxResults
services do contain services that match the criteria.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of services that you want Cloud Map to return in the response to a
ListServices
request. If you don’t specify a value forMaxResults
, Cloud Map returns up to 100 services.filters(ServiceFilter)
/set_filters(Option<Vec<ServiceFilter>>)
:A complex type that contains specifications for the namespaces that you want to list services for.
If you specify more than one filter, an operation must match all filters to be returned by
ListServices
.
- On success, responds with
ListServicesOutput
with field(s):services(Option<Vec<ServiceSummary>>)
:An array that contains one
ServiceSummary
object for each service that matches the specified filter criteria.next_token(Option<String>)
:If the response contains
NextToken
, submit anotherListServices
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Cloud Map gets
MaxResults
services and then filters them based on the specified criteria. It’s possible that no services in the firstMaxResults
services matched the specified criteria but that subsequent groups ofMaxResults
services do contain services that match the criteria.
- On failure, responds with
SdkError<ListServicesError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec<Tag>>)
:The tags that are assigned to the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn register_instance(&self) -> RegisterInstanceFluentBuilder
pub fn register_instance(&self) -> RegisterInstanceFluentBuilder
Constructs a fluent builder for the RegisterInstance
operation.
- The fluent builder is configurable:
service_id(impl Into<String>)
/set_service_id(Option<String>)
:The ID of the service that you want to use for settings for the instance.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:An identifier that you want to associate with the instance. Note the following:
-
If the service that’s specified by
ServiceId
includes settings for anSRV
record, the value ofInstanceId
is automatically included as part of the value for theSRV
record. For more information, see DnsRecord > Type. -
You can use this value to update an existing instance.
-
To register a new instance, you must specify a value that’s unique among instances that you register by using the same service.
-
If you specify an existing
InstanceId
andServiceId
, 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.The health check isn’t deleted immediately, so it will still appear for a while if you submit a
ListHealthChecks
request, for example.
Do not include sensitive information in
InstanceId
if the namespace is discoverable by public DNS queries and anyType
member ofDnsRecord
for the service containsSRV
because theInstanceId
is discoverable by public DNS queries.-
creator_request_id(impl Into<String>)
/set_creator_request_id(Option<String>)
:A unique string that identifies the request and that allows failed
RegisterInstance
requests to be retried without the risk of executing the operation twice. You must use a uniqueCreatorRequestId
string every time you submit aRegisterInstance
request if you’re registering additional instances for the same namespace and service.CreatorRequestId
can be any unique string (for example, a date/time stamp).attributes(impl Into<String>, impl Into<String>)
/set_attributes(Option<HashMap<String, String>>)
:A string map that contains the following information for the service that you specify in
ServiceId
:-
The attributes that apply to the records that are defined in the service.
-
For each attribute, the applicable value.
Do not include sensitive information in the attributes if the namespace is discoverable by public DNS queries.
Supported attribute keys include the following:
- AWS_ALIAS_DNS_NAME
-
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 AliasTarget in the Route 53 API Reference.
Note the following:
-
The configuration for the service that’s specified by
ServiceId
must include settings for anA
record, anAAAA
record, or both. -
In the service that’s specified by
ServiceId
, the value ofRoutingPolicy
must beWEIGHTED
. -
If the service that’s specified by
ServiceId
includesHealthCheckConfig
settings, Cloud Map will create the Route 53 health check, but it doesn’t associate the health check with the alias record. -
Auto naming currently doesn’t support creating alias records that route traffic to Amazon Web Services resources other than Elastic Load Balancing load balancers.
-
If you specify a value for
AWS_ALIAS_DNS_NAME
, don’t specify values for any of theAWS_INSTANCE
attributes.
-
- AWS_EC2_INSTANCE_ID
-
HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the
AWS_EC2_INSTANCE_ID
attribute is specified, then the only other attribute that can be specified isAWS_INIT_HEALTH_STATUS
. When theAWS_EC2_INSTANCE_ID
attribute is specified, then theAWS_INSTANCE_IPV4
attribute will be filled out with the primary private IPv4 address. - AWS_INIT_HEALTH_STATUS
-
If the service configuration includes
HealthCheckCustomConfig
, you can optionally useAWS_INIT_HEALTH_STATUS
to specify the initial status of the custom health check,HEALTHY
orUNHEALTHY
. If you don’t specify a value forAWS_INIT_HEALTH_STATUS
, the initial status isHEALTHY
. - AWS_INSTANCE_CNAME
-
If the service configuration includes a
CNAME
record, the domain name that you want Route 53 to return in response to DNS queries (for example,example.com
).This value is required if the service specified by
ServiceId
includes settings for anCNAME
record. - AWS_INSTANCE_IPV4
-
If the service configuration includes an
A
record, the IPv4 address that you want Route 53 to return in response to DNS queries (for example,192.0.2.44
).This value is required if the service specified by
ServiceId
includes settings for anA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_INSTANCE_IPV4
,AWS_INSTANCE_IPV6
, or both. - AWS_INSTANCE_IPV6
-
If the service configuration includes an
AAAA
record, the IPv6 address that you want Route 53 to return in response to DNS queries (for example,2001:0db8:85a3:0000:0000:abcd:0001:2345
).This value is required if the service specified by
ServiceId
includes settings for anAAAA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_INSTANCE_IPV4
,AWS_INSTANCE_IPV6
, or both. - AWS_INSTANCE_PORT
-
If the service includes an
SRV
record, the value that you want Route 53 to return for the port.If the service includes
HealthCheckConfig
, the port on the endpoint that you want Route 53 to send requests to.This value is required if you specified settings for an
SRV
record or a Route 53 health check when you created the service. - Custom attributes
-
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.
-
- On success, responds with
RegisterInstanceOutput
with field(s):operation_id(Option<String>)
:A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
- On failure, responds with
SdkError<RegisterInstanceError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.
tags(Tag)
/set_tags(Option<Vec<Tag>>)
: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.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag keys to remove from the specified resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_http_namespace(&self) -> UpdateHttpNamespaceFluentBuilder
pub fn update_http_namespace(&self) -> UpdateHttpNamespaceFluentBuilder
Constructs a fluent builder for the UpdateHttpNamespace
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the namespace that you want to update.
updater_request_id(impl Into<String>)
/set_updater_request_id(Option<String>)
:A unique string that identifies the request and that allows failed
UpdateHttpNamespace
requests to be retried without the risk of running the operation twice.UpdaterRequestId
can be any unique string (for example, a date/timestamp).namespace(HttpNamespaceChange)
/set_namespace(Option<HttpNamespaceChange>)
:Updated properties for the the HTTP namespace.
- On success, responds with
UpdateHttpNamespaceOutput
with field(s):operation_id(Option<String>)
:A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
- On failure, responds with
SdkError<UpdateHttpNamespaceError>
source§impl Client
impl Client
sourcepub fn update_instance_custom_health_status(
&self
) -> UpdateInstanceCustomHealthStatusFluentBuilder
pub fn update_instance_custom_health_status( &self ) -> UpdateInstanceCustomHealthStatusFluentBuilder
Constructs a fluent builder for the UpdateInstanceCustomHealthStatus
operation.
- The fluent builder is configurable:
service_id(impl Into<String>)
/set_service_id(Option<String>)
:The ID of the service that includes the configuration for the custom health check that you want to change the status for.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The ID of the instance that you want to change the health status for.
status(CustomHealthStatus)
/set_status(Option<CustomHealthStatus>)
:The new status of the instance,
HEALTHY
orUNHEALTHY
.
- On success, responds with
UpdateInstanceCustomHealthStatusOutput
- On failure, responds with
SdkError<UpdateInstanceCustomHealthStatusError>
source§impl Client
impl Client
sourcepub fn update_private_dns_namespace(
&self
) -> UpdatePrivateDnsNamespaceFluentBuilder
pub fn update_private_dns_namespace( &self ) -> UpdatePrivateDnsNamespaceFluentBuilder
Constructs a fluent builder for the UpdatePrivateDnsNamespace
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the namespace that you want to update.
updater_request_id(impl Into<String>)
/set_updater_request_id(Option<String>)
:A unique string that identifies the request and that allows failed
UpdatePrivateDnsNamespace
requests to be retried without the risk of running the operation twice.UpdaterRequestId
can be any unique string (for example, a date/timestamp).namespace(PrivateDnsNamespaceChange)
/set_namespace(Option<PrivateDnsNamespaceChange>)
:Updated properties for the private DNS namespace.
- On success, responds with
UpdatePrivateDnsNamespaceOutput
with field(s):operation_id(Option<String>)
:A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
- On failure, responds with
SdkError<UpdatePrivateDnsNamespaceError>
source§impl Client
impl Client
sourcepub fn update_public_dns_namespace(
&self
) -> UpdatePublicDnsNamespaceFluentBuilder
pub fn update_public_dns_namespace( &self ) -> UpdatePublicDnsNamespaceFluentBuilder
Constructs a fluent builder for the UpdatePublicDnsNamespace
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the namespace being updated.
updater_request_id(impl Into<String>)
/set_updater_request_id(Option<String>)
:A unique string that identifies the request and that allows failed
UpdatePublicDnsNamespace
requests to be retried without the risk of running the operation twice.UpdaterRequestId
can be any unique string (for example, a date/timestamp).namespace(PublicDnsNamespaceChange)
/set_namespace(Option<PublicDnsNamespaceChange>)
:Updated properties for the public DNS namespace.
- On success, responds with
UpdatePublicDnsNamespaceOutput
with field(s):operation_id(Option<String>)
:A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
- On failure, responds with
SdkError<UpdatePublicDnsNamespaceError>
source§impl Client
impl Client
sourcepub fn update_service(&self) -> UpdateServiceFluentBuilder
pub fn update_service(&self) -> UpdateServiceFluentBuilder
Constructs a fluent builder for the UpdateService
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the service that you want to update.
service(ServiceChange)
/set_service(Option<ServiceChange>)
:A complex type that contains the new settings for the service.
- On success, responds with
UpdateServiceOutput
with field(s):operation_id(Option<String>)
:A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
- On failure, responds with
SdkError<UpdateServiceError>
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it.