Struct aws_sdk_ssm::types::AssociationVersionInfo
source · #[non_exhaustive]pub struct AssociationVersionInfo {Show 20 fields
pub association_id: Option<String>,
pub association_version: Option<String>,
pub created_date: Option<DateTime>,
pub name: Option<String>,
pub document_version: Option<String>,
pub parameters: Option<HashMap<String, Vec<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>,
pub duration: Option<i32>,
pub target_maps: Option<Vec<HashMap<String, Vec<String>>>>,
}
Expand description
Information about the association version.
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.association_id: Option<String>
The ID created by the system when the association was created.
association_version: Option<String>
The association version.
created_date: Option<DateTime>
The date the association version was created.
name: Option<String>
The name specified when the association was created.
document_version: Option<String>
The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.
parameters: Option<HashMap<String, Vec<String>>>
Parameters specified when the association version was created.
targets: Option<Vec<Target>>
The targets specified for the association when the association version was created.
schedule_expression: Option<String>
The cron or rate schedule specified for the association when the association version was created.
output_location: Option<InstanceAssociationOutputLocation>
The location in Amazon S3 specified for the association when the association version was created.
association_name: Option<String>
The name specified for the association version when the association version was created.
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 that is assigned 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 for this version only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
target_locations: Option<Vec<TargetLocation>>
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.
schedule_offset: Option<i32>
Number of days to wait after the scheduled day to run an association.
duration: Option<i32>
The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
target_maps: Option<Vec<HashMap<String, Vec<String>>>>
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
Implementations§
source§impl AssociationVersionInfo
impl AssociationVersionInfo
sourcepub fn association_id(&self) -> Option<&str>
pub fn association_id(&self) -> Option<&str>
The ID created by the system when the association was created.
sourcepub fn association_version(&self) -> Option<&str>
pub fn association_version(&self) -> Option<&str>
The association version.
sourcepub fn created_date(&self) -> Option<&DateTime>
pub fn created_date(&self) -> Option<&DateTime>
The date the association version was created.
sourcepub fn document_version(&self) -> Option<&str>
pub fn document_version(&self) -> Option<&str>
The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.
sourcepub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>
pub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>
Parameters specified when the association version was created.
sourcepub fn targets(&self) -> &[Target]
pub fn targets(&self) -> &[Target]
The targets specified for the association when the association version was created.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .targets.is_none()
.
sourcepub fn schedule_expression(&self) -> Option<&str>
pub fn schedule_expression(&self) -> Option<&str>
The cron or rate schedule specified for the association when the association version was created.
sourcepub fn output_location(&self) -> Option<&InstanceAssociationOutputLocation>
pub fn output_location(&self) -> Option<&InstanceAssociationOutputLocation>
The location in Amazon S3 specified for the association when the association version was created.
sourcepub fn association_name(&self) -> Option<&str>
pub fn association_name(&self) -> Option<&str>
The name specified for the association version when the association version was created.
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 that is assigned 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) -> &[String]
pub fn calendar_names(&self) -> &[String]
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .calendar_names.is_none()
.
sourcepub fn target_locations(&self) -> &[TargetLocation]
pub fn target_locations(&self) -> &[TargetLocation]
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target_locations.is_none()
.
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.
sourcepub fn duration(&self) -> Option<i32>
pub fn duration(&self) -> Option<i32>
The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
sourcepub fn target_maps(&self) -> &[HashMap<String, Vec<String>>]
pub fn target_maps(&self) -> &[HashMap<String, Vec<String>>]
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target_maps.is_none()
.
source§impl AssociationVersionInfo
impl AssociationVersionInfo
sourcepub fn builder() -> AssociationVersionInfoBuilder
pub fn builder() -> AssociationVersionInfoBuilder
Creates a new builder-style object to manufacture AssociationVersionInfo
.
Trait Implementations§
source§impl Clone for AssociationVersionInfo
impl Clone for AssociationVersionInfo
source§fn clone(&self) -> AssociationVersionInfo
fn clone(&self) -> AssociationVersionInfo
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AssociationVersionInfo
impl Debug for AssociationVersionInfo
source§impl PartialEq for AssociationVersionInfo
impl PartialEq for AssociationVersionInfo
source§fn eq(&self, other: &AssociationVersionInfo) -> bool
fn eq(&self, other: &AssociationVersionInfo) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for AssociationVersionInfo
Auto Trait Implementations§
impl Freeze for AssociationVersionInfo
impl RefUnwindSafe for AssociationVersionInfo
impl Send for AssociationVersionInfo
impl Sync for AssociationVersionInfo
impl Unpin for AssociationVersionInfo
impl UnwindSafe for AssociationVersionInfo
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> 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 more