ResourceDataSync

ssm.services.k8s.aws/v1alpha1

TypeLink
GoDocssm-controller/apis/v1alpha1#ResourceDataSync

Metadata

PropertyValue
ScopeNamespaced
KindResourceDataSync
ListKindResourceDataSyncList
Pluralresourcedatasyncs
Singularresourcedatasync

Spec

s3Destination: 
  awsKMSKeyARN: string
  bucketName: string
  destinationDataSharing: 
    destinationDataSharingType: string
  prefix: string
  region: string
  syncFormat: string
syncName: string
syncSource: 
  awsOrganizationsSource: 
    organizationSourceType: string
    organizationalUnits:
    - organizationalUnitID: string
  enableAllOpsDataSources: boolean
  includeFutureRegions: boolean
  sourceRegions:
  - string
  sourceType: string
syncType: string
FieldDescription
s3Destination
Optional
object
Amazon S3 configuration details for the sync. This parameter is required
if the SyncType value is SyncToDestination.
s3Destination.awsKMSKeyARN
Optional
string
s3Destination.bucketName
Optional
string
s3Destination.destinationDataSharing
Optional
object
Synchronize Amazon Web Services Systems Manager Inventory data from multiple
Amazon Web Services accounts defined in Organizations to a centralized Amazon
S3 bucket. Data is synchronized to individual key prefixes in the central
bucket. Each key prefix represents a different Amazon Web Services account
ID.
s3Destination.destinationDataSharing.destinationDataSharingType
Optional
string
s3Destination.prefix
Optional
string
s3Destination.region
Optional
string
s3Destination.syncFormat
Optional
string
syncName
Required
string
A name for the configuration.
syncSource
Optional
object
Specify information about the data sources to synchronize. This parameter
is required if the SyncType value is SyncFromSource.
syncSource.awsOrganizationsSource
Optional
object
Information about the AwsOrganizationsSource resource data sync source. A
sync source of this type can synchronize data from Organizations or, if an
Amazon Web Services organization isn’t present, from multiple Amazon Web
Services Regions.
syncSource.awsOrganizationsSource.organizationSourceType
Optional
string
syncSource.awsOrganizationsSource.organizationalUnits
Optional
array
syncSource.awsOrganizationsSource.organizationalUnits.[]
Required
object
The Organizations organizational unit data source for the sync.
syncSource.enableAllOpsDataSources
Optional
boolean
syncSource.includeFutureRegions
Optional
boolean
syncSource.sourceRegions
Optional
array
syncSource.sourceRegions.[]
Required
string
syncType
Optional
string
Specify SyncToDestination to create a resource data sync that synchronizes
data to an S3 bucket for Inventory. If you specify SyncToDestination, you
must provide a value for S3Destination. Specify SyncFromSource to synchronize
data from a single account and multiple Regions, or multiple Amazon Web Services
accounts and Amazon Web Services Regions, as listed in Organizations for
Explorer. If you specify SyncFromSource, you must provide a value for SyncSource.
The default value is SyncToDestination.

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
FieldDescription
ackResourceMetadata
Optional
object
All CRs managed by ACK have a common Status.ACKResourceMetadata member
that is used to contain resource sync state, account ownership,
constructed ARN for the resource
ackResourceMetadata.arn
Optional
string
ARN is the Amazon Resource Name for the resource. This is a
globally-unique identifier and is set only by the ACK service controller
once the controller has orchestrated the creation of the resource OR
when it has verified that an “adopted” resource (a resource where the
ARN annotation was set by the Kubernetes user on the CR) exists and
matches the supplied CR’s Spec field values.
https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID
Required
string
OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.
ackResourceMetadata.region
Required
string
Region is the AWS region in which the resource exists or will exist.
conditions
Optional
array
All CRS managed by ACK have a common Status.Conditions member that
contains a collection of ackv1alpha1.Condition objects that describe
the various terminal states of the CR and its backend AWS service API
resource
conditions.[]
Required
object
Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message
Optional
string
A human readable message indicating details about the transition.
conditions.[].reason
Optional
string
The reason for the condition’s last transition.
conditions.[].status
Optional
string
Status of the condition, one of True, False, Unknown.
conditions.[].type
Optional
string
Type is the type of the Condition