Class ResourceDataSyncSourceWithState

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

The data type name for including resource data sync state. There are four sync states:

OrganizationNotExists (Your organization doesn't exist)

NoPermissions (The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in Amazon Web Services Systems Manager Explorer.)

InvalidOrganizationalUnit (You specified or selected an invalid unit in the resource data sync configuration.)

TrustedAccessDisabled (You disabled Systems Manager access in the organization in Organizations.)

See Also:

  • Method Details

    • sourceType

      public final String sourceType()

      The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in Organizations) or singleAccountMultiRegions.

      Returns:
      The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in Organizations) or singleAccountMultiRegions.

    • awsOrganizationsSource

      public final ResourceDataSyncAwsOrganizationsSource awsOrganizationsSource()

      The field name in SyncSource for the ResourceDataSyncAwsOrganizationsSource type.

      Returns:
      The field name in SyncSource for the ResourceDataSyncAwsOrganizationsSource type.

    • hasSourceRegions

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

    • sourceRegions

      public final List<String> sourceRegions()

      The SyncSource Amazon Web Services Regions included in the resource data sync.

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

      Returns:
      The SyncSource Amazon Web Services Regions included in the resource data sync.

    • includeFutureRegions

      public final Boolean includeFutureRegions()

      Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.

      Returns:
      Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.

    • state

      public final String state()

      The data type name for including resource data sync state. There are four sync states:

      OrganizationNotExists: Your organization doesn't exist.

      NoPermissions: The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in Explorer.

      InvalidOrganizationalUnit: You specified or selected an invalid unit in the resource data sync configuration.

      TrustedAccessDisabled: You disabled Systems Manager access in the organization in Organizations.

      Returns:
      The data type name for including resource data sync state. There are four sync states:

      OrganizationNotExists: Your organization doesn't exist.

      NoPermissions: The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in Explorer.

      InvalidOrganizationalUnit: You specified or selected an invalid unit in the resource data sync configuration.

      TrustedAccessDisabled: You disabled Systems Manager access in the organization in Organizations.

    • enableAllOpsDataSources

      public final Boolean enableAllOpsDataSources()

      When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in your organization (or in the selected organization units). For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.

      Returns:
      When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in your organization (or in the selected organization units). For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.

    • toBuilder

      public ResourceDataSyncSourceWithState.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<ResourceDataSyncSourceWithState.Builder,ResourceDataSyncSourceWithState>
      Returns:
      a builder for type T

    • builder

      public static ResourceDataSyncSourceWithState.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ResourceDataSyncSourceWithState.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.