CreateAssociationRequest (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.17.59 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ssm.model.SsmRequest
    - - software.amazon.awssdk.services.ssm.model.CreateAssociationRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateAssociationRequest
extends SsmRequest
implements ToCopyableBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateAssociationRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateAssociationRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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()` Specify the target for the association.
`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`	`hasTargetLocations()` For responses, this returns true if the service returned a value for the TargetLocations property.
`boolean`	`hasTargets()` For responses, this returns true if the service returned a value for the Targets property.
`String`	`instanceId()` The instance 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 instance.
`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).
`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<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<Target>`	`targets()` The targets for the association.
`CreateAssociationRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final 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 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.
    
    Returns:
    
    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.
  - documentVersion
```
public final String documentVersion()
```
    The document version you want to associate with the target(s). Can be a specific version or the default version.
    
    Returns:
    
    The document version you want to associate with the target(s). Can be a specific version or the default version.
  - instanceId
```
public final 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.
    
    Returns:
    
    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.
  - hasParameters
```
public final boolean hasParameters()
```
    For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - parameters
```
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.
    
    Returns:
    
    The parameters for the runtime configuration of the document.
  - hasTargets
```
public final boolean hasTargets()
```
    For responses, this returns true if the service returned a value for the Targets property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - targets
```
public final List<Target> 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.
    
    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.
    
    Returns:
    
    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.
  - scheduleExpression
```
public final String scheduleExpression()
```
    A cron expression when the association will be applied to the target(s).
    
    Returns:
    
    A cron expression when the association will be applied to the target(s).
  - outputLocation
```
public final InstanceAssociationOutputLocation outputLocation()
```
    An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
    
    Returns:
    
    An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
  - associationName
```
public final String associationName()
```
    Specify a descriptive name for the association.
    
    Returns:
    
    Specify a descriptive name for the association.
  - automationTargetParameterName
```
public final 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.
    
    Returns:
    
    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.
  - maxErrors
```
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 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.
    
    Returns:
    
    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.
  - maxConcurrency
```
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 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.
    
    Returns:
    
    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.
  - complianceSeverity
```
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().
    
    Returns:
    
    The severity level to assign to the association.
    
    See Also:
    
    AssociationComplianceSeverity
  - complianceSeverityAsString
```
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().
    
    Returns:
    
    The severity level to assign to the association.
    
    See Also:
    
    AssociationComplianceSeverity
  - syncCompliance
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    AssociationSyncCompliance
  - syncComplianceAsString
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    AssociationSyncCompliance
  - applyOnlyAtCronInterval
```
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.
    
    Returns:
    
    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.
  - hasCalendarNames
```
public final boolean hasCalendarNames()
```
    For responses, this returns true if the service returned a value for the CalendarNames property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - calendarNames
```
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.
    
    Returns:
    
    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.
  - hasTargetLocations
```
public final boolean hasTargetLocations()
```
    For responses, this returns true if the service returned a value for the TargetLocations property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - targetLocations
```
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.
    
    Returns:
    
    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.
  - toBuilder
```
public CreateAssociationRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>
    
    Specified by:
    
    toBuilder in class SsmRequest
  - builder
```
public static CreateAssociationRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateAssociationRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateAssociationRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

documentVersion

instanceId

hasParameters

parameters

hasTargets

targets

scheduleExpression

outputLocation

associationName

automationTargetParameterName

maxErrors

maxConcurrency

complianceSeverity

complianceSeverityAsString

syncCompliance

syncComplianceAsString

applyOnlyAtCronInterval

hasCalendarNames

calendarNames

hasTargetLocations

targetLocations

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields