Struct aws_sdk_ssm::client::fluent_builders::AddTagsToResource
source · [−]pub struct AddTagsToResource { /* private fields */ }
Expand description
Fluent builder constructing a request to AddTagsToResource
.
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example:
-
Key=Owner,Value=DbAdmin
-
Key=Owner,Value=SysAdmin
-
Key=Owner,Value=Dev
-
Key=Stack,Value=Production
-
Key=Stack,Value=Pre-Production
-
Key=Stack,Value=Test
Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
Implementations
sourceimpl AddTagsToResource
impl AddTagsToResource
sourcepub async fn send(
self
) -> Result<AddTagsToResourceOutput, SdkError<AddTagsToResourceError>>
pub async fn send(
self
) -> Result<AddTagsToResourceOutput, SdkError<AddTagsToResourceError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn resource_type(self, input: ResourceTypeForTagging) -> Self
pub fn resource_type(self, input: ResourceTypeForTagging) -> Self
Specifies the type of resource you are tagging.
The ManagedInstance
type for this API operation is for on-premises managed nodes. You must specify the name of the managed node in the following format: mi-ID_number
. For example, mi-1a2b3c4d5e6f
.
sourcepub fn set_resource_type(self, input: Option<ResourceTypeForTagging>) -> Self
pub fn set_resource_type(self, input: Option<ResourceTypeForTagging>) -> Self
Specifies the type of resource you are tagging.
The ManagedInstance
type for this API operation is for on-premises managed nodes. You must specify the name of the managed node in the following format: mi-ID_number
. For example, mi-1a2b3c4d5e6f
.
sourcepub fn resource_id(self, input: impl Into<String>) -> Self
pub fn resource_id(self, input: impl Into<String>) -> Self
The resource ID you want to tag.
Use the ID of the resource. Here are some examples:
MaintenanceWindow
: mw-012345abcde
PatchBaseline
: pb-012345abcde
Automation
: example-c160-4567-8519-012345abcde
OpsMetadata
object: ResourceID
for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID
is created from the strings that come after the word opsmetadata
in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager
has a ResourceID
of either aws/ssm/MyGroup/appmanager
or /aws/ssm/MyGroup/appmanager
.
For the Document
and Parameter
values, use the name of the resource.
ManagedInstance
: mi-012345abcde
The ManagedInstance
type for this API operation is only for on-premises managed nodes. You must specify the name of the managed node in the following format: mi-ID_number
. For example, mi-1a2b3c4d5e6f
.
sourcepub fn set_resource_id(self, input: Option<String>) -> Self
pub fn set_resource_id(self, input: Option<String>) -> Self
The resource ID you want to tag.
Use the ID of the resource. Here are some examples:
MaintenanceWindow
: mw-012345abcde
PatchBaseline
: pb-012345abcde
Automation
: example-c160-4567-8519-012345abcde
OpsMetadata
object: ResourceID
for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID
is created from the strings that come after the word opsmetadata
in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager
has a ResourceID
of either aws/ssm/MyGroup/appmanager
or /aws/ssm/MyGroup/appmanager
.
For the Document
and Parameter
values, use the name of the resource.
ManagedInstance
: mi-012345abcde
The ManagedInstance
type for this API operation is only for on-premises managed nodes. You must specify the name of the managed node in the following format: mi-ID_number
. For example, mi-1a2b3c4d5e6f
.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
One or more tags. The value parameter is required.
Don't enter personally identifiable information in this field.
One or more tags. The value parameter is required.
Don't enter personally identifiable information in this field.
Trait Implementations
sourceimpl Clone for AddTagsToResource
impl Clone for AddTagsToResource
sourcefn clone(&self) -> AddTagsToResource
fn clone(&self) -> AddTagsToResource
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for AddTagsToResource
impl Send for AddTagsToResource
impl Sync for AddTagsToResource
impl Unpin for AddTagsToResource
impl !UnwindSafe for AddTagsToResource
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more