Struct aws_sdk_ssm::client::fluent_builders::CreateActivation
source · [−]pub struct CreateActivation { /* private fields */ }Expand description
Fluent builder constructing a request to CreateActivation.
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.
Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.
Implementations
sourceimpl CreateActivation
impl CreateActivation
sourcepub async fn send(
self
) -> Result<CreateActivationOutput, SdkError<CreateActivationError>>
pub async fn send(
self
) -> Result<CreateActivationOutput, SdkError<CreateActivationError>>
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 description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A user-defined description of the resource that you want to register with Systems Manager.
Don't enter personally identifiable information in this field.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A user-defined description of the resource that you want to register with Systems Manager.
Don't enter personally identifiable information in this field.
sourcepub fn default_instance_name(self, input: impl Into<String>) -> Self
pub fn default_instance_name(self, input: impl Into<String>) -> Self
The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.
Don't enter personally identifiable information in this field.
sourcepub fn set_default_instance_name(self, input: Option<String>) -> Self
pub fn set_default_instance_name(self, input: Option<String>) -> Self
The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.
Don't enter personally identifiable information in this field.
sourcepub fn iam_role(self, input: impl Into<String>) -> Self
pub fn iam_role(self, input: impl Into<String>) -> Self
The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the Amazon Web Services Systems Manager User Guide.
sourcepub fn set_iam_role(self, input: Option<String>) -> Self
pub fn set_iam_role(self, input: Option<String>) -> Self
The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the Amazon Web Services Systems Manager User Guide.
sourcepub fn registration_limit(self, input: i32) -> Self
pub fn registration_limit(self, input: i32) -> Self
Specify the maximum number of managed nodes you want to register. The default value is 1.
sourcepub fn set_registration_limit(self, input: Option<i32>) -> Self
pub fn set_registration_limit(self, input: Option<i32>) -> Self
Specify the maximum number of managed nodes you want to register. The default value is 1.
sourcepub fn expiration_date(self, input: DateTime) -> Self
pub fn expiration_date(self, input: DateTime) -> Self
The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.
sourcepub fn set_expiration_date(self, input: Option<DateTime>) -> Self
pub fn set_expiration_date(self, input: Option<DateTime>) -> Self
The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.
Appends an item to Tags.
To override the contents of this collection use set_tags.
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:
-
Key=OS,Value=Windows -
Key=Environment,Value=Production
When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.
You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:
-
Key=OS,Value=Windows -
Key=Environment,Value=Production
When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.
You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.
sourcepub fn registration_metadata(self, input: RegistrationMetadataItem) -> Self
pub fn registration_metadata(self, input: RegistrationMetadataItem) -> Self
Appends an item to RegistrationMetadata.
To override the contents of this collection use set_registration_metadata.
Reserved for internal use.
sourcepub fn set_registration_metadata(
self,
input: Option<Vec<RegistrationMetadataItem>>
) -> Self
pub fn set_registration_metadata(
self,
input: Option<Vec<RegistrationMetadataItem>>
) -> Self
Reserved for internal use.
Trait Implementations
sourceimpl Clone for CreateActivation
impl Clone for CreateActivation
sourcefn clone(&self) -> CreateActivation
fn clone(&self) -> CreateActivation
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 CreateActivation
impl Send for CreateActivation
impl Sync for CreateActivation
impl Unpin for CreateActivation
impl !UnwindSafe for CreateActivation
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