Class SsmDocumentConfig

java.lang.Object
software.amazon.awssdk.services.arcregionswitch.model.SsmDocumentConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SsmDocumentConfig.Builder,SsmDocumentConfig>
@Generated("software.amazon.awssdk:codegen") public final class SsmDocumentConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SsmDocumentConfig.Builder,SsmDocumentConfig>

The Systems Manager document to run and the managed nodes to target for a single Amazon Web Services Region.

See Also:

  • Method Details

    • crossAccountRole

      public final String crossAccountRole()

      The cross-account role for the configuration.

      Returns:
      The cross-account role for the configuration.

    • externalId

      public final String externalId()

      The external ID (secret key) for the configuration.

      Returns:
      The external ID (secret key) for the configuration.

    • documentArn

      public final String documentArn()

      The Amazon Resource Name (ARN) of the Systems Manager document to run.

      Returns:
      The Amazon Resource Name (ARN) of the Systems Manager document to run.

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

      The target filters that Systems Manager resolves to managed nodes when the command runs. To target specific managed nodes, use the InstanceIds key. You can specify up to five target filters.

      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 target filters that Systems Manager resolves to managed nodes when the command runs. To target specific managed nodes, use the InstanceIds key. You can specify up to five target filters.

    • 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 that are passed to this Region's Systems Manager document. You set parameters for each document, so each Region can run its document with its own parameters.

      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 that are passed to this Region's Systems Manager document. You set parameters for each document, so each Region can run its document with its own parameters.

    • documentVersion

      public final String documentVersion()

      The version of the Systems Manager document to run for this Region. When you omit it, Systems Manager runs the document's default version.

      Returns:
      The version of the Systems Manager document to run for this Region. When you omit it, Systems Manager runs the document's default version.

    • toBuilder

      public SsmDocumentConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SsmDocumentConfig.Builder,SsmDocumentConfig>
      Returns:
      a builder for type T

    • builder

      public static SsmDocumentConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SsmDocumentConfig.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.