#[non_exhaustive]pub struct CreateAssociationBatchRequestEntry {Show 17 fields
pub name: Option<String>,
pub instance_id: Option<String>,
pub parameters: Option<HashMap<String, Vec<String>>>,
pub automation_target_parameter_name: Option<String>,
pub document_version: Option<String>,
pub targets: Option<Vec<Target>>,
pub schedule_expression: Option<String>,
pub output_location: Option<InstanceAssociationOutputLocation>,
pub association_name: Option<String>,
pub max_errors: Option<String>,
pub max_concurrency: Option<String>,
pub compliance_severity: Option<AssociationComplianceSeverity>,
pub sync_compliance: Option<AssociationSyncCompliance>,
pub apply_only_at_cron_interval: bool,
pub calendar_names: Option<Vec<String>>,
pub target_locations: Option<Vec<TargetLocation>>,
pub schedule_offset: Option<i32>,
}
Expand description
Describes the association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.
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.name: Option<String>
The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline
or My-Document
.
instance_id: Option<String>
The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an association, use the Targets
parameter. Requests that include the parameter InstanceID
with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId
, you can't use the parameters AssociationName
, DocumentVersion
, MaxErrors
, MaxConcurrency
, OutputLocation
, or ScheduleExpression
. To use these parameters, you must use the Targets
parameter.
parameters: Option<HashMap<String, Vec<String>>>
A description of the parameters for a document.
automation_target_parameter_name: Option<String>
Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
document_version: Option<String>
The document version.
targets: Option<Vec<Target>>
The managed nodes targeted by the request.
schedule_expression: Option<String>
A cron expression that specifies a schedule when the association runs.
output_location: Option<InstanceAssociationOutputLocation>
An S3 bucket where you want to store the results of this request.
association_name: Option<String>
Specify a descriptive name for the association.
max_errors: Option<String>
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError
to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors
is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency
to 1 so that executions proceed one at a time.
max_concurrency: Option<String>
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency
associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency
.
compliance_severity: Option<AssociationComplianceSeverity>
The severity level to assign to the association.
sync_compliance: Option<AssociationSyncCompliance>
The mode for generating association compliance. You can specify AUTO
or MANUAL
. In AUTO
mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT
. If the association execution doesn't run successfully, the association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the PutComplianceItems
API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems
API operation.
By default, all associations use AUTO
mode.
apply_only_at_cron_interval: bool
By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
calendar_names: Option<Vec<String>>
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
target_locations: Option<Vec<TargetLocation>>
Use this action to create an association in multiple Regions and multiple accounts.
schedule_offset: Option<i32>
Number of days to wait after the scheduled day to run an association.
Implementations
sourceimpl CreateAssociationBatchRequestEntry
impl CreateAssociationBatchRequestEntry
sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline
or My-Document
.
sourcepub fn instance_id(&self) -> Option<&str>
pub fn instance_id(&self) -> Option<&str>
The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an association, use the Targets
parameter. Requests that include the parameter InstanceID
with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId
, you can't use the parameters AssociationName
, DocumentVersion
, MaxErrors
, MaxConcurrency
, OutputLocation
, or ScheduleExpression
. To use these parameters, you must use the Targets
parameter.
sourcepub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>
pub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>
A description of the parameters for a document.
sourcepub fn automation_target_parameter_name(&self) -> Option<&str>
pub fn automation_target_parameter_name(&self) -> Option<&str>
Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
sourcepub fn document_version(&self) -> Option<&str>
pub fn document_version(&self) -> Option<&str>
The document version.
sourcepub fn schedule_expression(&self) -> Option<&str>
pub fn schedule_expression(&self) -> Option<&str>
A cron expression that specifies a schedule when the association runs.
sourcepub fn output_location(&self) -> Option<&InstanceAssociationOutputLocation>
pub fn output_location(&self) -> Option<&InstanceAssociationOutputLocation>
An S3 bucket where you want to store the results of this request.
sourcepub fn association_name(&self) -> Option<&str>
pub fn association_name(&self) -> Option<&str>
Specify a descriptive name for the association.
sourcepub fn max_errors(&self) -> Option<&str>
pub fn max_errors(&self) -> Option<&str>
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError
to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors
is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency
to 1 so that executions proceed one at a time.
sourcepub fn max_concurrency(&self) -> Option<&str>
pub fn max_concurrency(&self) -> Option<&str>
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency
associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency
.
sourcepub fn compliance_severity(&self) -> Option<&AssociationComplianceSeverity>
pub fn compliance_severity(&self) -> Option<&AssociationComplianceSeverity>
The severity level to assign to the association.
sourcepub fn sync_compliance(&self) -> Option<&AssociationSyncCompliance>
pub fn sync_compliance(&self) -> Option<&AssociationSyncCompliance>
The mode for generating association compliance. You can specify AUTO
or MANUAL
. In AUTO
mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT
. If the association execution doesn't run successfully, the association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the PutComplianceItems
API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems
API operation.
By default, all associations use AUTO
mode.
sourcepub fn apply_only_at_cron_interval(&self) -> bool
pub fn apply_only_at_cron_interval(&self) -> bool
By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
sourcepub fn calendar_names(&self) -> Option<&[String]>
pub fn calendar_names(&self) -> Option<&[String]>
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
sourcepub fn target_locations(&self) -> Option<&[TargetLocation]>
pub fn target_locations(&self) -> Option<&[TargetLocation]>
Use this action to create an association in multiple Regions and multiple accounts.
sourcepub fn schedule_offset(&self) -> Option<i32>
pub fn schedule_offset(&self) -> Option<i32>
Number of days to wait after the scheduled day to run an association.
sourceimpl CreateAssociationBatchRequestEntry
impl CreateAssociationBatchRequestEntry
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateAssociationBatchRequestEntry
Trait Implementations
sourceimpl Clone for CreateAssociationBatchRequestEntry
impl Clone for CreateAssociationBatchRequestEntry
sourcefn clone(&self) -> CreateAssociationBatchRequestEntry
fn clone(&self) -> CreateAssociationBatchRequestEntry
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 PartialEq<CreateAssociationBatchRequestEntry> for CreateAssociationBatchRequestEntry
impl PartialEq<CreateAssociationBatchRequestEntry> for CreateAssociationBatchRequestEntry
sourcefn eq(&self, other: &CreateAssociationBatchRequestEntry) -> bool
fn eq(&self, other: &CreateAssociationBatchRequestEntry) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateAssociationBatchRequestEntry) -> bool
fn ne(&self, other: &CreateAssociationBatchRequestEntry) -> bool
This method tests for !=
.
impl StructuralPartialEq for CreateAssociationBatchRequestEntry
Auto Trait Implementations
impl RefUnwindSafe for CreateAssociationBatchRequestEntry
impl Send for CreateAssociationBatchRequestEntry
impl Sync for CreateAssociationBatchRequestEntry
impl Unpin for CreateAssociationBatchRequestEntry
impl UnwindSafe for CreateAssociationBatchRequestEntry
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