NAME
Paws::SSM::UpdateAssociation - Arguments for method UpdateAssociation on Paws::SSM
DESCRIPTION
This class represents the parameters used for calling the method UpdateAssociation on the Amazon Simple Systems Manager (SSM) service. Use the attributes of this class as arguments to method UpdateAssociation.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateAssociation.
SYNOPSIS
my $ssm = Paws->service('SSM');
my $UpdateAssociationResult = $ssm->UpdateAssociation(
AssociationId => 'MyAssociationId',
ApplyOnlyAtCronInterval => 1, # OPTIONAL
AssociationName => 'MyAssociationName', # OPTIONAL
AssociationVersion => 'MyAssociationVersion', # OPTIONAL
AutomationTargetParameterName =>
'MyAutomationTargetParameterName', # OPTIONAL
CalendarNames => [ 'MyCalendarNameOrARN', ... ], # OPTIONAL
ComplianceSeverity => 'CRITICAL', # OPTIONAL
DocumentVersion => 'MyDocumentVersion', # OPTIONAL
MaxConcurrency => 'MyMaxConcurrency', # OPTIONAL
MaxErrors => 'MyMaxErrors', # OPTIONAL
Name => 'MyDocumentARN', # OPTIONAL
OutputLocation => {
S3Location => {
OutputS3BucketName => 'MyS3BucketName', # min: 3, max: 63; OPTIONAL
OutputS3KeyPrefix => 'MyS3KeyPrefix', # max: 500; OPTIONAL
OutputS3Region => 'MyS3Region', # min: 3, max: 20; OPTIONAL
}, # OPTIONAL
}, # OPTIONAL
Parameters => { 'MyParameterName' => [ 'MyParameterValue', ... ], }
, # OPTIONAL
ScheduleExpression => 'MyScheduleExpression', # OPTIONAL
SyncCompliance => 'AUTO', # OPTIONAL
TargetLocations => [
{
Accounts => [ 'MyAccount', ... ], # min: 1, max: 50; OPTIONAL
ExecutionRoleName =>
'MyExecutionRoleName', # min: 1, max: 64; OPTIONAL
Regions => [ 'MyRegion', ... ], # min: 1, max: 50; OPTIONAL
TargetLocationMaxConcurrency => 'MyMaxConcurrency', # min: 1, max: 7
TargetLocationMaxErrors => 'MyMaxErrors', # min: 1, max: 7
},
...
], # OPTIONAL
Targets => [
{
Key => 'MyTargetKey', # min: 1, max: 163; OPTIONAL
Values => [ 'MyTargetValue', ... ], # max: 50; OPTIONAL
},
...
], # OPTIONAL
);
# Results:
my $AssociationDescription =
$UpdateAssociationResult->AssociationDescription;
# Returns a L<Paws::SSM::UpdateAssociationResult> object.Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ssm/UpdateAssociation
ATTRIBUTES
ApplyOnlyAtCronInterval => Bool
By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter is not supported for rate expressions.
Also, if you specified this option when you created the association, you can reset it. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.
REQUIRED AssociationId => Str
The ID of the association you want to update.
AssociationName => Str
The name of the association that you want to update.
AssociationVersion => Str
This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.
AutomationTargetParameterName => Str
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
CalendarNames => ArrayRef[Str|Undef]
The names or Amazon Resource Names (ARNs) of the Systems Manager 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 AWS Systems Manager Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar).
ComplianceSeverity => Str
The severity level to assign to the association.
Valid values are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
DocumentVersion => Str
The document version you want update for the association.
MaxConcurrency => 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 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.
MaxErrors => 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 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.
Name => Str
The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.
You can specify AWS-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 AWS 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 AWS-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.
OutputLocation => Paws::SSM::InstanceAssociationOutputLocation
An S3 bucket where you want to store the results of this request.
Parameters => Paws::SSM::Parameters
The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}
ScheduleExpression => Str
The cron expression used to schedule the association that you want to update.
SyncCompliance => Str
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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
By default, all associations use AUTO mode.
Valid values are: "AUTO", "MANUAL"
TargetLocations => ArrayRef[Paws::SSM::TargetLocation]
A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
Targets => ArrayRef[Paws::SSM::Target]
The targets of the association.
SEE ALSO
This class forms part of Paws, documenting arguments for method UpdateAssociation in Paws::SSM
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues