Struct aws_sdk_ssm::client::fluent_builders::CreateAssociation

pub struct CreateAssociation<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateAssociation.

A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.

Implementations

impl<C, M, R> CreateAssociation<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateAssociationOutput, SdkError<CreateAssociationError>> where
    R::Policy: SmithyRetryPolicy<CreateAssociationInputOperationOutputAlias, CreateAssociationOutput, CreateAssociationError, CreateAssociationInputOperationRetryAlias>, 

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.

pub fn name(self, inp: impl Into<String>) -> Self

The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.

You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.

For Systems Manager documents (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:partition: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.

pub fn set_name(self, input: Option<String>) -> Self

The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.

You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.

For Systems Manager documents (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:partition: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.

pub fn document_version(self, inp: impl Into<String>) -> Self

The document version you want to associate with the target(s). Can be a specific version or the default version.

pub fn set_document_version(self, input: Option<String>) -> Self

The document version you want to associate with the target(s). Can be a specific version or the default version.

pub fn instance_id(self, inp: impl Into<String>) -> Self

The instance ID.

InstanceId has been deprecated. To specify an instance 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.

pub fn set_instance_id(self, input: Option<String>) -> Self

The instance ID.

InstanceId has been deprecated. To specify an instance 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.

pub fn parameters(self, k: impl Into<String>, v: impl Into<Vec<String>>) -> Self

Adds a key-value pair to Parameters.

To override the contents of this collection use set_parameters.

The parameters for the runtime configuration of the document.

pub fn set_parameters(self, input: Option<HashMap<String, Vec<String>>>) -> Self

The parameters for the runtime configuration of the document.

pub fn targets(self, inp: impl Into<Target>) -> Self

Appends an item to Targets.

To override the contents of this collection use set_targets.

The targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an Amazon Web Services account, or individual instance IDs. You can target all instances in an Amazon Web Services account by specifying the InstanceIds key with a value of *. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.

pub fn set_targets(self, input: Option<Vec<Target>>) -> Self

The targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an Amazon Web Services account, or individual instance IDs. You can target all instances in an Amazon Web Services account by specifying the InstanceIds key with a value of *. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.

pub fn schedule_expression(self, inp: impl Into<String>) -> Self

A cron expression when the association will be applied to the target(s).

pub fn set_schedule_expression(self, input: Option<String>) -> Self

A cron expression when the association will be applied to the target(s).

pub fn output_location(self, inp: InstanceAssociationOutputLocation) -> Self

An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

pub fn set_output_location(
    self,
    input: Option<InstanceAssociationOutputLocation>
) -> Self

An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

pub fn association_name(self, inp: impl Into<String>) -> Self

Specify a descriptive name for the association.

pub fn set_association_name(self, input: Option<String>) -> Self

Specify a descriptive name for the association.

pub fn automation_target_parameter_name(self, inp: impl Into<String>) -> Self

Choose the parameter that will define how your automation will branch out. 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.

pub fn set_automation_target_parameter_name(self, input: Option<String>) -> Self

Choose the parameter that will define how your automation will branch out. 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.

pub fn max_errors(self, inp: impl Into<String>) -> Self

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 instances 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.

pub fn set_max_errors(self, input: Option<String>) -> Self

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 instances 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.

pub fn max_concurrency(self, inp: impl Into<String>) -> Self

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 instance 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 instance will process its association within the limit specified for MaxConcurrency.

pub fn set_max_concurrency(self, input: Option<String>) -> Self

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 instance 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 instance will process its association within the limit specified for MaxConcurrency.

pub fn compliance_severity(self, inp: AssociationComplianceSeverity) -> Self

The severity level to assign to the association.

pub fn set_compliance_severity(
    self,
    input: Option<AssociationComplianceSeverity>
) -> Self

The severity level to assign to the association.

pub fn sync_compliance(self, inp: AssociationSyncCompliance) -> Self

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. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

pub fn set_sync_compliance(
    self,
    input: Option<AssociationSyncCompliance>
) -> Self

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. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

pub fn apply_only_at_cron_interval(self, inp: bool) -> Self

By default, when you create a new association, 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.

pub fn set_apply_only_at_cron_interval(self, input: Option<bool>) -> Self

By default, when you create a new association, 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.

pub fn calendar_names(self, inp: impl Into<String>) -> Self

Appends an item to CalendarNames.

To override the contents of this collection use set_calendar_names.

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

pub fn set_calendar_names(self, input: Option<Vec<String>>) -> Self

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

pub fn target_locations(self, inp: impl Into<TargetLocation>) -> Self

Appends an item to TargetLocations.

To override the contents of this collection use set_target_locations.

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.

pub fn set_target_locations(self, input: Option<Vec<TargetLocation>>) -> Self

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CreateAssociation<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.