#[non_exhaustive]pub struct RegisterInstanceInput {
pub service_id: Option<String>,
pub instance_id: Option<String>,
pub creator_request_id: Option<String>,
pub attributes: Option<HashMap<String, String>>,
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.service_id: Option<String>The ID or Amazon Resource Name (ARN) of the service that you want to use for settings for the instance. For services created in a shared namespace, specify the service ARN. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
instance_id: Option<String>An identifier that you want to associate with the instance. Note the following:
-
If the service that's specified by
ServiceIdincludes settings for anSRVrecord, the value ofInstanceIdis automatically included as part of the value for theSRVrecord. 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
InstanceIdandServiceId, 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
ListHealthChecksrequest, for example.
Do not include sensitive information in InstanceId if the namespace is discoverable by public DNS queries and any Type member of DnsRecord for the service contains SRV because the InstanceId is discoverable by public DNS queries.
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 unique CreatorRequestId string every time you submit a RegisterInstance 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: 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.
The following are the supported attribute keys.
- 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
ServiceIdmust include settings for anArecord, anAAAArecord, or both. -
In the service that's specified by
ServiceId, the value ofRoutingPolicymust beWEIGHTED. -
If the service that's specified by
ServiceIdincludesHealthCheckConfigsettings, Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the alias record. -
Cloud Map 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_INSTANCEattributes. -
The
AWS_ALIAS_DNS_NAMEis not supported in the GovCloud (US) Regions.
-
- AWS_EC2_INSTANCE_ID
-
HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the
AWS_EC2_INSTANCE_IDattribute is specified, then the only other attribute that can be specified isAWS_INIT_HEALTH_STATUS. When theAWS_EC2_INSTANCE_IDattribute is specified, then theAWS_INSTANCE_IPV4attribute 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_STATUSto specify the initial status of the custom health check,HEALTHYorUNHEALTHY. If you don't specify a value forAWS_INIT_HEALTH_STATUS, the initial status isHEALTHY. - AWS_INSTANCE_CNAME
-
If the service configuration includes a
CNAMErecord, 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
ServiceIdincludes settings for anCNAMErecord. - AWS_INSTANCE_IPV4
-
If the service configuration includes an
Arecord, 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
ServiceIdincludes settings for anArecord. If the service includes settings for anSRVrecord, you must specify a value forAWS_INSTANCE_IPV4,AWS_INSTANCE_IPV6, or both. - AWS_INSTANCE_IPV6
-
If the service configuration includes an
AAAArecord, 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
ServiceIdincludes settings for anAAAArecord. If the service includes settings for anSRVrecord, you must specify a value forAWS_INSTANCE_IPV4,AWS_INSTANCE_IPV6, or both. - AWS_INSTANCE_PORT
-
If the service includes an
SRVrecord, 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
SRVrecord 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.
Implementations§
Source§impl RegisterInstanceInput
impl RegisterInstanceInput
Sourcepub fn service_id(&self) -> Option<&str>
pub fn service_id(&self) -> Option<&str>
The ID or Amazon Resource Name (ARN) of the service that you want to use for settings for the instance. For services created in a shared namespace, specify the service ARN. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
Sourcepub fn instance_id(&self) -> Option<&str>
pub fn instance_id(&self) -> Option<&str>
An identifier that you want to associate with the instance. Note the following:
-
If the service that's specified by
ServiceIdincludes settings for anSRVrecord, the value ofInstanceIdis automatically included as part of the value for theSRVrecord. 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
InstanceIdandServiceId, 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
ListHealthChecksrequest, for example.
Do not include sensitive information in InstanceId if the namespace is discoverable by public DNS queries and any Type member of DnsRecord for the service contains SRV because the InstanceId is discoverable by public DNS queries.
Sourcepub fn creator_request_id(&self) -> Option<&str>
pub fn creator_request_id(&self) -> Option<&str>
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 unique CreatorRequestId string every time you submit a RegisterInstance 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).
Sourcepub fn attributes(&self) -> Option<&HashMap<String, String>>
pub fn attributes(&self) -> 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.
The following are the supported attribute keys.
- 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
ServiceIdmust include settings for anArecord, anAAAArecord, or both. -
In the service that's specified by
ServiceId, the value ofRoutingPolicymust beWEIGHTED. -
If the service that's specified by
ServiceIdincludesHealthCheckConfigsettings, Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the alias record. -
Cloud Map 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_INSTANCEattributes. -
The
AWS_ALIAS_DNS_NAMEis not supported in the GovCloud (US) Regions.
-
- AWS_EC2_INSTANCE_ID
-
HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the
AWS_EC2_INSTANCE_IDattribute is specified, then the only other attribute that can be specified isAWS_INIT_HEALTH_STATUS. When theAWS_EC2_INSTANCE_IDattribute is specified, then theAWS_INSTANCE_IPV4attribute 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_STATUSto specify the initial status of the custom health check,HEALTHYorUNHEALTHY. If you don't specify a value forAWS_INIT_HEALTH_STATUS, the initial status isHEALTHY. - AWS_INSTANCE_CNAME
-
If the service configuration includes a
CNAMErecord, 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
ServiceIdincludes settings for anCNAMErecord. - AWS_INSTANCE_IPV4
-
If the service configuration includes an
Arecord, 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
ServiceIdincludes settings for anArecord. If the service includes settings for anSRVrecord, you must specify a value forAWS_INSTANCE_IPV4,AWS_INSTANCE_IPV6, or both. - AWS_INSTANCE_IPV6
-
If the service configuration includes an
AAAArecord, 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
ServiceIdincludes settings for anAAAArecord. If the service includes settings for anSRVrecord, you must specify a value forAWS_INSTANCE_IPV4,AWS_INSTANCE_IPV6, or both. - AWS_INSTANCE_PORT
-
If the service includes an
SRVrecord, 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
SRVrecord 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.
Source§impl RegisterInstanceInput
impl RegisterInstanceInput
Sourcepub fn builder() -> RegisterInstanceInputBuilder
pub fn builder() -> RegisterInstanceInputBuilder
Creates a new builder-style object to manufacture RegisterInstanceInput.
Trait Implementations§
Source§impl Clone for RegisterInstanceInput
impl Clone for RegisterInstanceInput
Source§fn clone(&self) -> RegisterInstanceInput
fn clone(&self) -> RegisterInstanceInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for RegisterInstanceInput
impl Debug for RegisterInstanceInput
Source§impl PartialEq for RegisterInstanceInput
impl PartialEq for RegisterInstanceInput
impl StructuralPartialEq for RegisterInstanceInput
Auto Trait Implementations§
impl Freeze for RegisterInstanceInput
impl RefUnwindSafe for RegisterInstanceInput
impl Send for RegisterInstanceInput
impl Sync for RegisterInstanceInput
impl Unpin for RegisterInstanceInput
impl UnsafeUnpin for RegisterInstanceInput
impl UnwindSafe for RegisterInstanceInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);