software.amazon.awssdk.services.ssm.model

Class ResourceDataSyncSourceWithState

java.lang.Object

software.amazon.awssdk.services.ssm.model.ResourceDataSyncSourceWithState

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ResourceDataSyncSourceWithState.Builder,ResourceDataSyncSourceWithState>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResourceDataSyncSourceWithState.Builder

Method Summary

Modifier and Type	Method and Description
ResourceDataSyncAwsOrganizationsSource	awsOrganizationsSource() The field name in SyncSource for the ResourceDataSyncAwsOrganizationsSource type.
static ResourceDataSyncSourceWithState.Builder	builder()
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).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSourceRegions() For responses, this returns true if the service returned a value for the SourceRegions property.
Boolean	includeFutureRegions() Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.
List<SdkField<?>>	sdkFields()
static Class<? extends ResourceDataSyncSourceWithState.Builder>	serializableBuilderClass()
List<String>	sourceRegions() The SyncSource Amazon Web Services Regions included in the resource data sync.
String	sourceType() The type of data source for the resource data sync.
String	state() The data type name for including resource data sync state.
ResourceDataSyncSourceWithState.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

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 About multiple account and Region resource data syncs 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 About multiple account and Region resource data syncs in the Amazon Web Services Systems Manager User Guide.

toBuilder

public ResourceDataSyncSourceWithState.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceDataSyncSourceWithState.Builder,ResourceDataSyncSourceWithState>

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)

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo