public static interface CreateAssociationRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateAssociationRequest.Builder |
applyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)
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.
|
CreateAssociationRequest.Builder |
associationName(String associationName)
Specify a descriptive name for the association.
|
CreateAssociationRequest.Builder |
automationTargetParameterName(String automationTargetParameterName)
Specify the target for the association.
|
CreateAssociationRequest.Builder |
calendarNames(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your
associations under.
|
CreateAssociationRequest.Builder |
calendarNames(String... calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your
associations under.
|
CreateAssociationRequest.Builder |
complianceSeverity(AssociationComplianceSeverity complianceSeverity)
The severity level to assign to the association.
|
CreateAssociationRequest.Builder |
complianceSeverity(String complianceSeverity)
The severity level to assign to the association.
|
CreateAssociationRequest.Builder |
documentVersion(String documentVersion)
The document version you want to associate with the target(s).
|
CreateAssociationRequest.Builder |
instanceId(String instanceId)
The instance ID.
|
CreateAssociationRequest.Builder |
maxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run the association at the same time.
|
CreateAssociationRequest.Builder |
maxErrors(String maxErrors)
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets.
|
CreateAssociationRequest.Builder |
name(String name)
The name of the SSM Command document or Automation runbook that contains the configuration information for
the instance.
|
default CreateAssociationRequest.Builder |
outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation)
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the
request.
|
CreateAssociationRequest.Builder |
outputLocation(InstanceAssociationOutputLocation outputLocation)
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the
request.
|
CreateAssociationRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateAssociationRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CreateAssociationRequest.Builder |
parameters(Map<String,? extends Collection<String>> parameters)
The parameters for the runtime configuration of the document.
|
CreateAssociationRequest.Builder |
scheduleExpression(String scheduleExpression)
A cron expression when the association will be applied to the target(s).
|
CreateAssociationRequest.Builder |
syncCompliance(AssociationSyncCompliance syncCompliance)
The mode for generating association compliance.
|
CreateAssociationRequest.Builder |
syncCompliance(String syncCompliance)
The mode for generating association compliance.
|
CreateAssociationRequest.Builder |
targetLocations(Collection<TargetLocation> targetLocations)
A location is a combination of Regions and accounts where you want to run the association.
|
CreateAssociationRequest.Builder |
targetLocations(Consumer<TargetLocation.Builder>... targetLocations)
A location is a combination of Regions and accounts where you want to run the association.
|
CreateAssociationRequest.Builder |
targetLocations(TargetLocation... targetLocations)
A location is a combination of Regions and accounts where you want to run the association.
|
CreateAssociationRequest.Builder |
targets(Collection<Target> targets)
The targets for the association.
|
CreateAssociationRequest.Builder |
targets(Consumer<Target.Builder>... targets)
The targets for the association.
|
CreateAssociationRequest.Builder |
targets(Target... targets)
The targets for the association.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateAssociationRequest.Builder name(String name)
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 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.
name - 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 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.
CreateAssociationRequest.Builder documentVersion(String documentVersion)
The document version you want to associate with the target(s). Can be a specific version or the default version.
documentVersion - The document version you want to associate with the target(s). Can be a specific version or the
default version.CreateAssociationRequest.Builder instanceId(String instanceId)
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.
instanceId - 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.
CreateAssociationRequest.Builder parameters(Map<String,? extends Collection<String>> parameters)
The parameters for the runtime configuration of the document.
parameters - The parameters for the runtime configuration of the document.CreateAssociationRequest.Builder targets(Collection<Target> targets)
The targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an account, or individual instance IDs. 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.
targets - The targets for the association. You can target instances by using tags, Amazon Web Services resource
groups, all instances in an account, or individual instance IDs. 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.CreateAssociationRequest.Builder targets(Target... targets)
The targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an account, or individual instance IDs. 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.
targets - The targets for the association. You can target instances by using tags, Amazon Web Services resource
groups, all instances in an account, or individual instance IDs. 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.CreateAssociationRequest.Builder targets(Consumer<Target.Builder>... targets)
The targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an account, or individual instance IDs. 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.
This is a convenience that creates an instance of theList.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its
result is passed to #targets(List) .targets - a consumer that will call methods on List.Builder #targets(List) CreateAssociationRequest.Builder scheduleExpression(String scheduleExpression)
A cron expression when the association will be applied to the target(s).
scheduleExpression - A cron expression when the association will be applied to the target(s).CreateAssociationRequest.Builder outputLocation(InstanceAssociationOutputLocation outputLocation)
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
outputLocation - An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the
request.default CreateAssociationRequest.Builder outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation)
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
This is a convenience that creates an instance of theInstanceAssociationOutputLocation.Builder
avoiding the need to create one manually via InstanceAssociationOutputLocation.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to outputLocation(InstanceAssociationOutputLocation).outputLocation - a consumer that will call methods on InstanceAssociationOutputLocation.BuilderoutputLocation(InstanceAssociationOutputLocation)CreateAssociationRequest.Builder associationName(String associationName)
Specify a descriptive name for the association.
associationName - Specify a descriptive name for the association.CreateAssociationRequest.Builder automationTargetParameterName(String automationTargetParameterName)
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.
automationTargetParameterName - 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.CreateAssociationRequest.Builder maxErrors(String maxErrors)
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.
maxErrors - 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.
CreateAssociationRequest.Builder maxConcurrency(String maxConcurrency)
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.
maxConcurrency - 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.
CreateAssociationRequest.Builder complianceSeverity(String complianceSeverity)
The severity level to assign to the association.
complianceSeverity - The severity level to assign to the association.AssociationComplianceSeverity,
AssociationComplianceSeverityCreateAssociationRequest.Builder complianceSeverity(AssociationComplianceSeverity complianceSeverity)
The severity level to assign to the association.
complianceSeverity - The severity level to assign to the association.AssociationComplianceSeverity,
AssociationComplianceSeverityCreateAssociationRequest.Builder syncCompliance(String syncCompliance)
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.
syncCompliance - 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.
AssociationSyncCompliance,
AssociationSyncComplianceCreateAssociationRequest.Builder syncCompliance(AssociationSyncCompliance syncCompliance)
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.
syncCompliance - 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.
AssociationSyncCompliance,
AssociationSyncComplianceCreateAssociationRequest.Builder applyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)
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.
applyOnlyAtCronInterval - 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.CreateAssociationRequest.Builder calendarNames(Collection<String> calendarNames)
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.
calendarNames - 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.CreateAssociationRequest.Builder calendarNames(String... calendarNames)
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.
calendarNames - 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.CreateAssociationRequest.Builder targetLocations(Collection<TargetLocation> targetLocations)
A location is a combination of Regions and accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
targetLocations - A location is a combination of Regions and accounts where you want to run the association. Use this
action to create an association in multiple Regions and multiple accounts.CreateAssociationRequest.Builder targetLocations(TargetLocation... targetLocations)
A location is a combination of Regions and accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
targetLocations - A location is a combination of Regions and accounts where you want to run the association. Use this
action to create an association in multiple Regions and multiple accounts.CreateAssociationRequest.Builder targetLocations(Consumer<TargetLocation.Builder>... targetLocations)
A location is a combination of Regions and accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
This is a convenience that creates an instance of theList.Builder avoiding the need
to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and
its result is passed to #targetLocations(List) .targetLocations - a consumer that will call methods on List.Builder #targetLocations(List) CreateAssociationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.CreateAssociationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.