Struct aws_sdk_ssm::input::CreateActivationInput
source · [−]#[non_exhaustive]pub struct CreateActivationInput {
pub description: Option<String>,
pub default_instance_name: Option<String>,
pub iam_role: Option<String>,
pub registration_limit: Option<i32>,
pub expiration_date: Option<DateTime>,
pub tags: Option<Vec<Tag>>,
pub registration_metadata: Option<Vec<RegistrationMetadataItem>>,
}
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.description: Option<String>
A user-defined description of the resource that you want to register with Systems Manager.
Don't enter personally identifiable information in this field.
default_instance_name: Option<String>
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.
iam_role: Option<String>
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.
registration_limit: Option<i32>
Specify the maximum number of managed nodes you want to register. The default value is 1
.
expiration_date: Option<DateTime>
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.
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
.
registration_metadata: Option<Vec<RegistrationMetadataItem>>
Reserved for internal use.
Implementations
sourceimpl CreateActivationInput
impl CreateActivationInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateActivation, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateActivation, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CreateActivation
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateActivationInput
.
sourceimpl CreateActivationInput
impl CreateActivationInput
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
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) -> Option<&str>
pub fn default_instance_name(&self) -> Option<&str>
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) -> Option<&str>
pub fn iam_role(&self) -> Option<&str>
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) -> Option<i32>
pub fn registration_limit(&self) -> Option<i32>
Specify the maximum number of managed nodes you want to register. The default value is 1
.
sourcepub fn expiration_date(&self) -> Option<&DateTime>
pub fn expiration_date(&self) -> Option<&DateTime>
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.
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) -> Option<&[RegistrationMetadataItem]>
pub fn registration_metadata(&self) -> Option<&[RegistrationMetadataItem]>
Reserved for internal use.
Trait Implementations
sourceimpl Clone for CreateActivationInput
impl Clone for CreateActivationInput
sourcefn clone(&self) -> CreateActivationInput
fn clone(&self) -> CreateActivationInput
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
sourceimpl Debug for CreateActivationInput
impl Debug for CreateActivationInput
sourceimpl PartialEq<CreateActivationInput> for CreateActivationInput
impl PartialEq<CreateActivationInput> for CreateActivationInput
sourcefn eq(&self, other: &CreateActivationInput) -> bool
fn eq(&self, other: &CreateActivationInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateActivationInput) -> bool
fn ne(&self, other: &CreateActivationInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for CreateActivationInput
Auto Trait Implementations
impl RefUnwindSafe for CreateActivationInput
impl Send for CreateActivationInput
impl Sync for CreateActivationInput
impl Unpin for CreateActivationInput
impl UnwindSafe for CreateActivationInput
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> 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