@Generated(value="software.amazon.awssdk:codegen") public final class CreateAssociationRequest extends SsmRequest implements ToCopyableBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateAssociationRequest.Builder |
Modifier and Type | Method and Description |
---|---|
AlarmConfiguration |
alarmConfiguration()
Returns the value of the AlarmConfiguration property for this object.
|
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.
|
String |
associationName()
Specify a descriptive name for the association.
|
String |
automationTargetParameterName()
Choose the parameter that will define how your automation will branch out.
|
static CreateAssociationRequest.Builder |
builder() |
List<String> |
calendarNames()
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your
associations under.
|
AssociationComplianceSeverity |
complianceSeverity()
The severity level to assign to the association.
|
String |
complianceSeverityAsString()
The severity level to assign to the association.
|
String |
documentVersion()
The document version you want to associate with the target(s).
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasCalendarNames()
For responses, this returns true if the service returned a value for the CalendarNames property.
|
int |
hashCode() |
boolean |
hasParameters()
For responses, this returns true if the service returned a value for the Parameters property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
boolean |
hasTargetLocations()
For responses, this returns true if the service returned a value for the TargetLocations property.
|
boolean |
hasTargetMaps()
For responses, this returns true if the service returned a value for the TargetMaps property.
|
boolean |
hasTargets()
For responses, this returns true if the service returned a value for the Targets property.
|
String |
instanceId()
The managed node ID.
|
String |
maxConcurrency()
The maximum number of targets allowed to run the association at the same time.
|
String |
maxErrors()
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets.
|
String |
name()
The name of the SSM Command document or Automation runbook that contains the configuration information for the
managed node.
|
InstanceAssociationOutputLocation |
outputLocation()
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
|
Map<String,List<String>> |
parameters()
The parameters for the runtime configuration of the document.
|
String |
scheduleExpression()
A cron expression when the association will be applied to the target(s).
|
Integer |
scheduleOffset()
Number of days to wait after the scheduled day to run an association.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateAssociationRequest.Builder> |
serializableBuilderClass() |
AssociationSyncCompliance |
syncCompliance()
The mode for generating association compliance.
|
String |
syncComplianceAsString()
The mode for generating association compliance.
|
List<Tag> |
tags()
Adds or overwrites one or more tags for a State Manager association.
|
List<TargetLocation> |
targetLocations()
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run
the association.
|
List<Map<String,List<String>>> |
targetMaps()
A key-value mapping of document parameters to target resources.
|
List<Target> |
targets()
The targets for the association.
|
CreateAssociationRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String name()
The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another Amazon Web Services 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
.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another Amazon Web Services 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
.
public final String documentVersion()
The document version you want to associate with the target(s). Can be a specific version or the default version.
State Manager doesn't support running associations that use a new version of a document if that document is
shared from another account. State Manager always runs the default
version of a document if shared
from another account, even though the Systems Manager console shows that a new version was processed. If you want
to run an association using a new version of a document shared form another account, you must set the document
version to default
.
State Manager doesn't support running associations that use a new version of a document if that document
is shared from another account. State Manager always runs the default
version of a document
if shared from another account, even though the Systems Manager console shows that a new version was
processed. If you want to run an association using a new version of a document shared form another
account, you must set the document version to default
.
public final String instanceId()
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.
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.
public final boolean hasParameters()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final Map<String,List<String>> parameters()
The parameters for the runtime configuration of the document.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasParameters()
method.
public final boolean hasTargets()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<Target> targets()
The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups,
all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all managed
nodes 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTargets()
method.
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.public final String scheduleExpression()
A cron expression when the association will be applied to the target(s).
public final InstanceAssociationOutputLocation outputLocation()
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
public final String associationName()
Specify a descriptive name for the association.
public final String automationTargetParameterName()
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.
public final 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 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.
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.
public final 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 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
.
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
.
public final AssociationComplianceSeverity complianceSeverity()
The severity level to assign to the association.
If the service returns an enum value that is not available in the current SDK version,
complianceSeverity
will return AssociationComplianceSeverity.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from complianceSeverityAsString()
.
AssociationComplianceSeverity
public final String complianceSeverityAsString()
The severity level to assign to the association.
If the service returns an enum value that is not available in the current SDK version,
complianceSeverity
will return AssociationComplianceSeverity.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from complianceSeverityAsString()
.
AssociationComplianceSeverity
public final 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.
If the service returns an enum value that is not available in the current SDK version, syncCompliance
will return AssociationSyncCompliance.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from syncComplianceAsString()
.
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
public final String syncComplianceAsString()
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.
If the service returns an enum value that is not available in the current SDK version, syncCompliance
will return AssociationSyncCompliance.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from syncComplianceAsString()
.
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
public final 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.
public final boolean hasCalendarNames()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasCalendarNames()
method.
public final boolean hasTargetLocations()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<TargetLocation> targetLocations()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTargetLocations()
method.
public final Integer scheduleOffset()
Number of days to wait after the scheduled day to run an association. For example, if you specified a cron
schedule of cron(0 0 ? * THU#2 *)
, you could specify an offset of 3 to run the association each
Sunday after the second Thursday of the month. For more information about cron schedules for associations, see
Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User
Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval
parameter. This option tells the system
not to run an association immediately after you create it.
cron(0 0 ? * THU#2 *)
, you could specify an offset of 3 to run the
association each Sunday after the second Thursday of the month. For more information about cron schedules
for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems
Manager User Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval
parameter. This option tells
the system not to run an association immediately after you create it.
public final boolean hasTargetMaps()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<Map<String,List<String>>> targetMaps()
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTargetMaps()
method.
public final boolean hasTags()
isEmpty()
method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags()
method.
public final AlarmConfiguration alarmConfiguration()
public CreateAssociationRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>
toBuilder
in class SsmRequest
public static CreateAssociationRequest.Builder builder()
public static Class<? extends CreateAssociationRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2023. All rights reserved.