Package software.amazon.awssdk.services.ssm.model

Class AssociationDescription

    • Method Detail

      • name

        public final String name()

        The name of the SSM document.

        Returns:
        The name of the SSM document.

      • instanceId

        public final String instanceId()

        The managed node ID.

        Returns:
        The managed node ID.

      • associationVersion

        public final String associationVersion()

        The association version.

        Returns:
        The association version.

      • date

        public final Instant date()

        The date when the association was made.

        Returns:
        The date when the association was made.

      • lastUpdateAssociationDate

        public final Instant lastUpdateAssociationDate()

        The date when the association was last updated.

        Returns:
        The date when the association was last updated.

      • status

        public final AssociationStatus status()

        The association status.

        Returns:
        The association status.

      • overview

        public final AssociationOverview overview()

        Information about the association.

        Returns:
        Information about the association.

      • documentVersion

        public final String documentVersion()

        The document version.

        Returns:
        The document version.

      • automationTargetParameterName

        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.

        Returns:
        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.

      • 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()

        A description of the parameters for a 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:
        A description of the parameters for a document.

      • associationId

        public final String associationId()

        The association ID.

        Returns:
        The association ID.

      • 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 managed nodes targeted by the request.

        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 managed nodes targeted by the request.

      • scheduleExpression

        public final String scheduleExpression()

        A cron expression that specifies a schedule when the association runs.

        Returns:
        A cron expression that specifies a schedule when the association runs.

      • outputLocation

        public final InstanceAssociationOutputLocation outputLocation()

        An S3 bucket where you want to store the output details of the request.

        Returns:
        An S3 bucket where you want to store the output details of the request.

      • lastExecutionDate

        public final Instant lastExecutionDate()

        The date on which the association was last run.

        Returns:
        The date on which the association was last run.

      • lastSuccessfulExecutionDate

        public final Instant lastSuccessfulExecutionDate()

        The last date on which the association was successfully run.

        Returns:
        The last date on which the association was successfully run.

      • associationName

        public final String associationName()

        The association name.

        Returns:
        The association name.

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

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

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

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

      • 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, a capability of Amazon Web Services Systems 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, a capability of Amazon Web Services Systems 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, a capability of Amazon Web Services Systems 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, a capability of Amazon Web Services Systems 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 associations, 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 associations, 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 your associations are gated 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 your associations are gated 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()

        The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

        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:
        The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

      • scheduleOffset

        public final Integer scheduleOffset()

        Number of days to wait after the scheduled day to run an association.

        Returns:
        Number of days to wait after the scheduled day to run an association.

      • duration

        public final Integer duration()

        The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.

        Returns:
        The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.

      • hasTargetMaps

        public final boolean hasTargetMaps()
        For responses, this returns true if the service returned a value for the TargetMaps 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.

      • targetMaps

        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.

        Returns:
        A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

      • alarmConfiguration

        public final AlarmConfiguration alarmConfiguration()
        Returns the value of the AlarmConfiguration property for this object.
        Returns:
        The value of the AlarmConfiguration property for this object.

      • hasTriggeredAlarms

        public final boolean hasTriggeredAlarms()
        For responses, this returns true if the service returned a value for the TriggeredAlarms 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.

      • triggeredAlarms

        public final List<AlarmStateInformation> triggeredAlarms()

        The CloudWatch alarm that was invoked during the association.

        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 hasTriggeredAlarms() method.

        Returns:
        The CloudWatch alarm that was invoked during the association.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)