DataSync

13 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

DataSyncAgent # CLOUD CONTROL · AWS::DataSync::Agent

DataSyncAgent manages AWS::DataSync::Agent through the AWS Cloud Control API.

kubectl get datasyncagents · example on GitHub

Example

# DataSyncAgent — DataSync
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/datasync.html#datasyncagent
apiVersion: aws.konfig.io/v1alpha1
kind: DataSyncAgent
metadata:
  name: example-datasyncagent
  namespace: default
spec:
  activationKey: example
  agentName: example-datasyncagent
  providerRef:
    name: example-datasyncagent
    region: us-east-1
  securityGroupArns:
  - example
  subnetArns:
  - example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`activationKey`	string	—	Activation key of the Agent.
`agentName`	string	—	The name configured for the agent.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`securityGroupArns`	array<string>	—	The ARNs of the security group used to protect your data transfer task subnets.
`subnetArns`	array<string>	—	The ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes
`vpcEndpointId`	string	—	The ID of the VPC endpoint that the agent has access to.

Status

Field	Type	Required	Description
`agentArn`	string	—	The DataSync Agent ARN.
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`endpointType`	enum	—	The service endpoints that the agent will connect to. Allowed: `FIPS, PUBLIC, PRIVATE_LINK`
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DataSyncLocationAzureBlob # CLOUD CONTROL · AWS::DataSync::LocationAzureBlob

DataSyncLocationAzureBlob manages AWS::DataSync::LocationAzureBlob through the AWS Cloud Control API.

kubectl get datasynclocationazureblobs · example on GitHub

Example

# DataSyncLocationAzureBlob — DataSync
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/datasync.html#datasynclocationazureblob
apiVersion: aws.konfig.io/v1alpha1
kind: DataSyncLocationAzureBlob
metadata:
  name: example-datasynclocationazureblob
  namespace: default
spec:
  agentArns:
  - example
  azureAccessTier: HOT
  azureBlobAuthenticationType: SAS
  azureBlobContainerUrl: example
  azureBlobSasConfiguration:
    azureBlobSasToken: example
  azureBlobType: BLOCK
  cmkSecretConfig:
    kmsKeyArn: arn:aws:iam::123456789012:role/example-role
    secretArn: arn:aws:iam::123456789012:role/example-role
  customSecretConfig:
    secretAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    secretArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-datasynclocationazureblob
    region: us-east-1
  subdirectory: example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`agentArns`	array<string>	—	Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.
`azureAccessTier`	enum	—	Specifies an access tier for the objects you're transferring into your Azure Blob Storage container. Allowed: `HOT, COOL, ARCHIVE`
`azureBlobAuthenticationType`	enum	yes	The specific authentication type that you want DataSync to use to access your Azure Blob Container. Allowed: `SAS, NONE`
`azureBlobContainerUrl`	string	—	The URL of the Azure Blob container that was described.
`azureBlobSasConfiguration`	object	—	DataSyncLocationAzureBlobAzureBlobSasConfiguration is a nested property type of AWS::DataSync::LocationAzureBlob.
`azureBlobSasConfiguration.azureBlobSasToken`	string	yes	Specifies the shared access signature (SAS) token, which indicates the permissions DataSync needs to access your Azure Blob Storage container.
`azureBlobType`	enum	—	Specifies a blob type for the objects you're transferring into your Azure Blob Storage container. Allowed: `BLOCK`
`cmkSecretConfig`	object	—	DataSyncLocationAzureBlobCmkSecretConfig is a nested property type of AWS::DataSync::LocationAzureBlob.
`cmkSecretConfig.kmsKeyArn`	string	—	Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn.
`cmkSecretConfig.secretArn`	string	—	Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
`customSecretConfig`	object	—	DataSyncLocationAzureBlobCustomSecretConfig is a nested property type of AWS::DataSync::LocationAzureBlob.
`customSecretConfig.secretAccessRoleArn`	string	yes	Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
`customSecretConfig.secretArn`	string	yes	Specifies the ARN for a customer created AWS Secrets Manager secret.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`subdirectory`	string	—	The subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`locationArn`	string	—	The Amazon Resource Name (ARN) of the Azure Blob Location that is created.
`locationUri`	string	—	The URL of the Azure Blob Location that was described.
`managedSecretConfig`	object	—	Read-only: reported by AWS after creation.
`managedSecretConfig.secretArn`	string	yes	Specifies the ARN for an AWS Secrets Manager secret.
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DataSyncLocationEFS # CLOUD CONTROL · AWS::DataSync::LocationEFS

DataSyncLocationEFS manages AWS::DataSync::LocationEFS through the AWS Cloud Control API.

kubectl get datasynclocationefses · example on GitHub

Example

# DataSyncLocationEFS — DataSync
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/datasync.html#datasynclocationefs
apiVersion: aws.konfig.io/v1alpha1
kind: DataSyncLocationEFS
metadata:
  name: example-datasynclocationefs
  namespace: default
spec:
  accessPointArn: arn:aws:iam::123456789012:role/example-role
  ec2Config:
    securityGroupArns:
    - example
    subnetArn: arn:aws:iam::123456789012:role/example-role
  efsFilesystemArn: arn:aws:iam::123456789012:role/example-role
  fileSystemAccessRoleArn: arn:aws:iam::123456789012:role/example-role
  inTransitEncryption: NONE
  providerRef:
    name: example-datasynclocationefs
    region: us-east-1
  subdirectory: example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`accessPointArn`	string	—	The Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system.
`ec2Config`	object	yes	Create-only in AWS: changing it requires replacing the resource.
`ec2Config.securityGroupArns`	array<string>	yes	The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource.
`ec2Config.subnetArn`	string	yes	The ARN of the subnet that DataSync uses to access the target EFS file system.
`efsFilesystemArn`	string	—	The Amazon Resource Name (ARN) for the Amazon EFS file system.
`fileSystemAccessRoleArn`	string	—	The Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system.
`inTransitEncryption`	enum	—	Protocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system. Allowed: `NONE, TLS1_2`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`subdirectory`	string	—	A subdirectory in the location's path.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`locationArn`	string	—	The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.
`locationUri`	string	—	The URL of the EFS location that was described.
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DataSyncLocationFSxLustre # CLOUD CONTROL · AWS::DataSync::LocationFSxLustre

DataSyncLocationFSxLustre manages AWS::DataSync::LocationFSxLustre through the AWS Cloud Control API.

kubectl get datasynclocationfsxlustres · example on GitHub

Example

# DataSyncLocationFSxLustre — DataSync
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/datasync.html#datasynclocationfsxlustre
apiVersion: aws.konfig.io/v1alpha1
kind: DataSyncLocationFSxLustre
metadata:
  name: example-datasynclocationfsxlustre
  namespace: default
spec:
  fsxFilesystemArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-datasynclocationfsxlustre
    region: us-east-1
  securityGroupArns:
  - example
  subdirectory: example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`fsxFilesystemArn`	string	—	The Amazon Resource Name (ARN) for the FSx for Lustre file system.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`securityGroupArns`	array<string>	yes	The ARNs of the security groups that are to use to configure the FSx for Lustre file system.
`subdirectory`	string	—	A subdirectory in the location's path.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`locationArn`	string	—	The Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created.
`locationUri`	string	—	The URL of the FSx for Lustre location that was described.
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DataSyncLocationFSxONTAP # CLOUD CONTROL · AWS::DataSync::LocationFSxONTAP

DataSyncLocationFSxONTAP manages AWS::DataSync::LocationFSxONTAP through the AWS Cloud Control API.

kubectl get datasynclocationfsxontaps · example on GitHub

Example

# DataSyncLocationFSxONTAP — DataSync
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/datasync.html#datasynclocationfsxontap
apiVersion: aws.konfig.io/v1alpha1
kind: DataSyncLocationFSxONTAP
metadata:
  name: example-datasynclocationfsxontap
  namespace: default
spec:
  protocol:
    nfs:
      mountOptions:
        version: AUTOMATIC
    smb:
      cmkSecretConfig:
        kmsKeyArn: arn:aws:iam::123456789012:role/example-role
        secretArn: arn:aws:iam::123456789012:role/example-role
      customSecretConfig:
        secretAccessRoleArn: arn:aws:iam::123456789012:role/example-role
        secretArn: arn:aws:iam::123456789012:role/example-role
      domain: example
      managedSecretConfig:
        secretArn: arn:aws:iam::123456789012:role/example-role
      mountOptions:
        version: AUTOMATIC
      password: example
      user: example
  providerRef:
    name: example-datasynclocationfsxontap
    region: us-east-1
  securityGroupArns:
  - example
  storageVirtualMachineArn: arn:aws:iam::123456789012:role/example-role
  subdirectory: example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`protocol`	object	—	DataSyncLocationFSxONTAPProtocol is a nested property type of AWS::DataSync::LocationFSxONTAP.
`protocol.nfs`	object	—	DataSyncLocationFSxONTAPNFS is a nested property type of AWS::DataSync::LocationFSxONTAP.
`protocol.nfs.mountOptions`	object	yes	DataSyncLocationFSxONTAPNfsMountOptions is a nested property type of AWS::DataSync::LocationFSxONTAP.
`protocol.nfs.mountOptions.version`	enum	—	The specific NFS version that you want DataSync to use to mount your NFS share. Allowed: `AUTOMATIC, NFS3, NFS4_0, NFS4_1`
`protocol.smb`	object	—	DataSyncLocationFSxONTAPSMB is a nested property type of AWS::DataSync::LocationFSxONTAP.
`protocol.smb.cmkSecretConfig`	object	—	DataSyncLocationFSxONTAPCmkSecretConfig is a nested property type of AWS::DataSync::LocationFSxONTAP.
`protocol.smb.cmkSecretConfig.kmsKeyArn`	string	—	Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn.
`protocol.smb.cmkSecretConfig.secretArn`	string	—	Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
`protocol.smb.customSecretConfig`	object	—	DataSyncLocationFSxONTAPCustomSecretConfig is a nested property type of AWS::DataSync::LocationFSxONTAP.
`protocol.smb.customSecretConfig.secretAccessRoleArn`	string	yes	Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
`protocol.smb.customSecretConfig.secretArn`	string	yes	Specifies the ARN for a customer created AWS Secrets Manager secret.
`protocol.smb.domain`	string	—	The name of the Windows domain that the SMB server belongs to.
`protocol.smb.managedSecretConfig`	object	—	DataSyncLocationFSxONTAPManagedSecretConfig is a nested property type of AWS::DataSync::LocationFSxONTAP.
`protocol.smb.managedSecretConfig.secretArn`	string	yes	Specifies the ARN for an AWS Secrets Manager secret.
`protocol.smb.mountOptions`	object	yes	DataSyncLocationFSxONTAPSmbMountOptions is a nested property type of AWS::DataSync::LocationFSxONTAP.
`protocol.smb.mountOptions.version`	enum	—	The specific SMB version that you want DataSync to use to mount your SMB share. Allowed: `AUTOMATIC, SMB2, SMB3`
`protocol.smb.password`	string	—	The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
`protocol.smb.user`	string	yes	The user who can mount the share, has the permissions to access files and folders in the SMB share.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`securityGroupArns`	array<string>	yes	The ARNs of the security groups that are to use to configure the FSx ONTAP file system.
`storageVirtualMachineArn`	string	yes	The Amazon Resource Name (ARN) for the FSx ONTAP SVM.
`subdirectory`	string	—	A subdirectory in the location's path.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`fsxFilesystemArn`	string	—	The Amazon Resource Name (ARN) for the FSx ONAP file system.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`locationArn`	string	—	The Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.
`locationUri`	string	—	The URL of the FSx ONTAP file system that was described.
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DataSyncLocationFSxOpenZFS # CLOUD CONTROL · AWS::DataSync::LocationFSxOpenZFS

DataSyncLocationFSxOpenZFS manages AWS::DataSync::LocationFSxOpenZFS through the AWS Cloud Control API.

kubectl get datasynclocationfsxopenzfses · example on GitHub

Example

# DataSyncLocationFSxOpenZFS — DataSync
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/datasync.html#datasynclocationfsxopenzfs
apiVersion: aws.konfig.io/v1alpha1
kind: DataSyncLocationFSxOpenZFS
metadata:
  name: example-datasynclocationfsxopenzfs
  namespace: default
spec:
  fsxFilesystemArn: arn:aws:iam::123456789012:role/example-role
  protocol:
    nfs:
      mountOptions:
        version: AUTOMATIC
  providerRef:
    name: example-datasynclocationfsxopenzfs
    region: us-east-1
  securityGroupArns:
  - example
  subdirectory: example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`fsxFilesystemArn`	string	—	The Amazon Resource Name (ARN) for the FSx OpenZFS file system.
`protocol`	object	yes	DataSyncLocationFSxOpenZFSProtocol is a nested property type of AWS::DataSync::LocationFSxOpenZFS.
`protocol.nfs`	object	—	DataSyncLocationFSxOpenZFSNFS is a nested property type of AWS::DataSync::LocationFSxOpenZFS.
`protocol.nfs.mountOptions`	object	yes	DataSyncLocationFSxOpenZFSMountOptions is a nested property type of AWS::DataSync::LocationFSxOpenZFS.
`protocol.nfs.mountOptions.version`	enum	—	The specific NFS version that you want DataSync to use to mount your NFS share. Allowed: `AUTOMATIC, NFS3, NFS4_0, NFS4_1`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`securityGroupArns`	array<string>	yes	The ARNs of the security groups that are to use to configure the FSx OpenZFS file system.
`subdirectory`	string	—	A subdirectory in the location's path.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`locationArn`	string	—	The Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created.
`locationUri`	string	—	The URL of the FSx OpenZFS that was described.
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DataSyncLocationFSxWindows # CLOUD CONTROL · AWS::DataSync::LocationFSxWindows

DataSyncLocationFSxWindows manages AWS::DataSync::LocationFSxWindows through the AWS Cloud Control API.

kubectl get datasynclocationfsxwindows · example on GitHub

Example

# DataSyncLocationFSxWindows — DataSync
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/datasync.html#datasynclocationfsxwindows
apiVersion: aws.konfig.io/v1alpha1
kind: DataSyncLocationFSxWindows
metadata:
  name: example-datasynclocationfsxwindows
  namespace: default
spec:
  cmkSecretConfig:
    kmsKeyArn: arn:aws:iam::123456789012:role/example-role
    secretArn: arn:aws:iam::123456789012:role/example-role
  customSecretConfig:
    secretAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    secretArn: arn:aws:iam::123456789012:role/example-role
  domain: example
  fsxFilesystemArn: arn:aws:iam::123456789012:role/example-role
  password: example
  providerRef:
    name: example-datasynclocationfsxwindows
    region: us-east-1
  securityGroupArns:
  - example
  subdirectory: example
  tags:
  - key: example
    value: example
  user: example

Spec

Field	Type	Required	Description
`cmkSecretConfig`	object	—	DataSyncLocationFSxWindowsCmkSecretConfig is a nested property type of AWS::DataSync::LocationFSxWindows.
`cmkSecretConfig.kmsKeyArn`	string	—	Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn.
`cmkSecretConfig.secretArn`	string	—	Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
`customSecretConfig`	object	—	DataSyncLocationFSxWindowsCustomSecretConfig is a nested property type of AWS::DataSync::LocationFSxWindows.
`customSecretConfig.secretAccessRoleArn`	string	yes	Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
`customSecretConfig.secretArn`	string	yes	Specifies the ARN for a customer created AWS Secrets Manager secret.
`domain`	string	—	The name of the Windows domain that the FSx for Windows server belongs to.
`fsxFilesystemArn`	string	—	The Amazon Resource Name (ARN) for the FSx for Windows file system.
`password`	string	—	The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`securityGroupArns`	array<string>	yes	The ARNs of the security groups that are to use to configure the FSx for Windows file system.
`subdirectory`	string	—	A subdirectory in the location's path.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes
`user`	string	yes	The user who has the permissions to access files and folders in the FSx for Windows file system.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`locationArn`	string	—	The Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created.
`locationUri`	string	—	The URL of the FSx for Windows location that was described.
`managedSecretConfig`	object	—	Read-only: reported by AWS after creation.
`managedSecretConfig.secretArn`	string	yes	Specifies the ARN for an AWS Secrets Manager secret.
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DataSyncLocationHDFS # CLOUD CONTROL · AWS::DataSync::LocationHDFS

DataSyncLocationHDFS manages AWS::DataSync::LocationHDFS through the AWS Cloud Control API.

kubectl get datasynclocationhdfses · example on GitHub

Example

# DataSyncLocationHDFS — DataSync
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/datasync.html#datasynclocationhdfs
apiVersion: aws.konfig.io/v1alpha1
kind: DataSyncLocationHDFS
metadata:
  name: example-datasynclocationhdfs
  namespace: default
spec:
  agentArns:
  - example
  authenticationType: SIMPLE
  blockSize: 1048576
  cmkSecretConfig:
    kmsKeyArn: arn:aws:iam::123456789012:role/example-role
    secretArn: arn:aws:iam::123456789012:role/example-role
  customSecretConfig:
    secretAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    secretArn: arn:aws:iam::123456789012:role/example-role
  kerberosKeytab: example
  kerberosKrb5Conf: example
  kerberosPrincipal: example
  kmsKeyProviderUri: example
  nameNodes:
  - hostname: example-datasynclocationhdfs
    port: 1
  providerRef:
    name: example-datasynclocationhdfs
    region: us-east-1
  qopConfiguration:
    dataTransferProtection: AUTHENTICATION
    rpcProtection: AUTHENTICATION
  replicationFactor: 1
  simpleUser: example
  subdirectory: example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`agentArns`	array<string>	yes	ARN(s) of the agent(s) to use for an HDFS location.
`authenticationType`	enum	yes	The authentication mode used to determine identity of user. Allowed: `SIMPLE, KERBEROS`
`blockSize`	integer	—	Size of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster.
`cmkSecretConfig`	object	—	DataSyncLocationHDFSCmkSecretConfig is a nested property type of AWS::DataSync::LocationHDFS.
`cmkSecretConfig.kmsKeyArn`	string	—	Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn.
`cmkSecretConfig.secretArn`	string	—	Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
`customSecretConfig`	object	—	DataSyncLocationHDFSCustomSecretConfig is a nested property type of AWS::DataSync::LocationHDFS.
`customSecretConfig.secretAccessRoleArn`	string	yes	Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
`customSecretConfig.secretArn`	string	yes	Specifies the ARN for a customer created AWS Secrets Manager secret.
`kerberosKeytab`	string	—	The Base64 string representation of the Keytab file.
`kerberosKrb5Conf`	string	—	The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.
`kerberosPrincipal`	string	—	The unique identity, or principal, to which Kerberos can assign tickets.
`kmsKeyProviderUri`	string	—	The identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored.
`nameNodes`	array<object>	yes	An array of Name Node(s) of the HDFS location.
`nameNodes[].hostname`	string	yes	The DNS name or IP address of the Name Node in the customer's on premises HDFS cluster.
`nameNodes[].port`	integer	yes	The port on which the Name Node is listening on for client requests.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`qopConfiguration`	object	—	DataSyncLocationHDFSQopConfiguration is a nested property type of AWS::DataSync::LocationHDFS.
`qopConfiguration.dataTransferProtection`	enum	—	Configuration for Data Transfer Protection. Allowed: `AUTHENTICATION, INTEGRITY, PRIVACY, DISABLED`
`qopConfiguration.rpcProtection`	enum	—	Configuration for RPC Protection. Allowed: `AUTHENTICATION, INTEGRITY, PRIVACY, DISABLED`
`replicationFactor`	integer	—	Number of copies of each block that exists inside the HDFS cluster.
`simpleUser`	string	—	The user name that has read and write permissions on the specified HDFS cluster.
`subdirectory`	string	—	The subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`locationArn`	string	—	The Amazon Resource Name (ARN) of the HDFS location.
`locationUri`	string	—	The URL of the HDFS location that was described.
`managedSecretConfig`	object	—	Read-only: reported by AWS after creation.
`managedSecretConfig.secretArn`	string	yes	Specifies the ARN for an AWS Secrets Manager secret.
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DataSyncLocationNFS # CLOUD CONTROL · AWS::DataSync::LocationNFS

DataSyncLocationNFS manages AWS::DataSync::LocationNFS through the AWS Cloud Control API.

kubectl get datasynclocationnfses · example on GitHub

Example

# DataSyncLocationNFS — DataSync
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/datasync.html#datasynclocationnfs
apiVersion: aws.konfig.io/v1alpha1
kind: DataSyncLocationNFS
metadata:
  name: example-datasynclocationnfs
  namespace: default
spec:
  mountOptions:
    version: AUTOMATIC
  onPremConfig:
    agentArns:
    - example
  providerRef:
    name: example-datasynclocationnfs
    region: us-east-1
  serverHostname: example-datasynclocationnfs
  subdirectory: example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`mountOptions`	object	—	DataSyncLocationNFSMountOptions is a nested property type of AWS::DataSync::LocationNFS.
`mountOptions.version`	enum	—	The specific NFS version that you want DataSync to use to mount your NFS share. Allowed: `AUTOMATIC, NFS3, NFS4_0, NFS4_1`
`onPremConfig`	object	yes	DataSyncLocationNFSOnPremConfig is a nested property type of AWS::DataSync::LocationNFS.
`onPremConfig.agentArns`	array<string>	yes	ARN(s) of the agent(s) to use for an NFS location.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`serverHostname`	string	—	The name of the NFS server.
`subdirectory`	string	—	The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`locationArn`	string	—	The Amazon Resource Name (ARN) of the NFS location.
`locationUri`	string	—	The URL of the NFS location that was described.
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DataSyncLocationObjectStorage # CLOUD CONTROL · AWS::DataSync::LocationObjectStorage

DataSyncLocationObjectStorage manages AWS::DataSync::LocationObjectStorage through the AWS Cloud Control API.

kubectl get datasynclocationobjectstorages · example on GitHub

Example

# DataSyncLocationObjectStorage — DataSync
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/datasync.html#datasynclocationobjectstorage
apiVersion: aws.konfig.io/v1alpha1
kind: DataSyncLocationObjectStorage
metadata:
  name: example-datasynclocationobjectstorage
  namespace: default
spec:
  accessKey: example
  agentArns:
  - example
  bucketName: example-datasynclocationobjectstorage
  cmkSecretConfig:
    kmsKeyArn: arn:aws:iam::123456789012:role/example-role
    secretArn: arn:aws:iam::123456789012:role/example-role
  customSecretConfig:
    secretAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    secretArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-datasynclocationobjectstorage
    region: us-east-1
  secretKey: example
  serverCertificate: example
  serverHostname: example-datasynclocationobjectstorage
  serverPort: 1
  serverProtocol: HTTPS
  subdirectory: example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`accessKey`	string	—	Optional.
`agentArns`	array<string>	—	Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.
`bucketName`	string	—	The name of the bucket on the self-managed object storage server.
`cmkSecretConfig`	object	—	DataSyncLocationObjectStorageCmkSecretConfig is a nested property type of AWS::DataSync::LocationObjectStorage.
`cmkSecretConfig.kmsKeyArn`	string	—	Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn.
`cmkSecretConfig.secretArn`	string	—	Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
`customSecretConfig`	object	—	DataSyncLocationObjectStorageCustomSecretConfig is a nested property type of AWS::DataSync::LocationObjectStorage.
`customSecretConfig.secretAccessRoleArn`	string	yes	Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
`customSecretConfig.secretArn`	string	yes	Specifies the ARN for a customer created AWS Secrets Manager secret.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`secretKey`	string	—	Optional.
`serverCertificate`	string	—	X.509 PEM content containing a certificate authority or chain to trust.
`serverHostname`	string	—	The name of the self-managed object storage server.
`serverPort`	integer	—	The port that your self-managed server accepts inbound network traffic on.
`serverProtocol`	enum	—	The protocol that the object storage server uses to communicate. Allowed: `HTTPS, HTTP`
`subdirectory`	string	—	The subdirectory in the self-managed object storage server that is used to read data from.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`locationArn`	string	—	The Amazon Resource Name (ARN) of the location that is created.
`locationUri`	string	—	The URL of the object storage location that was described.
`managedSecretConfig`	object	—	Read-only: reported by AWS after creation.
`managedSecretConfig.secretArn`	string	yes	Specifies the ARN for an AWS Secrets Manager secret.
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DataSyncLocationS3 # CLOUD CONTROL · AWS::DataSync::LocationS3

DataSyncLocationS3 manages AWS::DataSync::LocationS3 through the AWS Cloud Control API.

kubectl get datasynclocations3s · example on GitHub

Example

# DataSyncLocationS3 — DataSync
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/datasync.html#datasynclocations3
apiVersion: aws.konfig.io/v1alpha1
kind: DataSyncLocationS3
metadata:
  name: example-datasynclocations3
  namespace: default
spec:
  providerRef:
    name: example-datasynclocations3
    region: us-east-1
  s3BucketArn: arn:aws:iam::123456789012:role/example-role
  s3Config:
    bucketAccessRoleArn: arn:aws:iam::123456789012:role/example-role
  s3StorageClass: STANDARD
  subdirectory: example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`s3BucketArn`	string	—	The Amazon Resource Name (ARN) of the Amazon S3 bucket.
`s3Config`	object	yes	DataSyncLocationS3S3Config is a nested property type of AWS::DataSync::LocationS3.
`s3Config.bucketAccessRoleArn`	string	yes	The ARN of the IAM role of the Amazon S3 bucket.
`s3StorageClass`	enum	—	The Amazon S3 storage class you want to store your files in when this location is used as a task destination. Allowed: `STANDARD, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, GLACIER_INSTANT_RETRIEVAL, DEEP_ARCHIVE`
`subdirectory`	string	—	A subdirectory in the Amazon S3 bucket.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`locationArn`	string	—	The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
`locationUri`	string	—	The URL of the S3 location that was described.
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DataSyncLocationSMB # CLOUD CONTROL · AWS::DataSync::LocationSMB

DataSyncLocationSMB manages AWS::DataSync::LocationSMB through the AWS Cloud Control API.

kubectl get datasynclocationsmbs · example on GitHub

Example

# DataSyncLocationSMB — DataSync
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/datasync.html#datasynclocationsmb
apiVersion: aws.konfig.io/v1alpha1
kind: DataSyncLocationSMB
metadata:
  name: example-datasynclocationsmb
  namespace: default
spec:
  agentArns:
  - example
  authenticationType: NTLM
  cmkSecretConfig:
    kmsKeyArn: arn:aws:iam::123456789012:role/example-role
    secretArn: arn:aws:iam::123456789012:role/example-role
  customSecretConfig:
    secretAccessRoleArn: arn:aws:iam::123456789012:role/example-role
    secretArn: arn:aws:iam::123456789012:role/example-role
  dnsIpAddresses:
  - example
  domain: example
  kerberosKeytab: example
  kerberosKrb5Conf: example
  kerberosPrincipal: example
  mountOptions:
    version: AUTOMATIC
  password: example
  providerRef:
    name: example-datasynclocationsmb
    region: us-east-1
  serverHostname: example-datasynclocationsmb
  subdirectory: example
  tags:
  - key: example
    value: example
  user: example

Spec

Field	Type	Required	Description
`agentArns`	array<string>	yes	The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
`authenticationType`	enum	—	The authentication mode used to determine identity of user. Allowed: `NTLM, KERBEROS`
`cmkSecretConfig`	object	—	DataSyncLocationSMBCmkSecretConfig is a nested property type of AWS::DataSync::LocationSMB.
`cmkSecretConfig.kmsKeyArn`	string	—	Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn.
`cmkSecretConfig.secretArn`	string	—	Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
`customSecretConfig`	object	—	DataSyncLocationSMBCustomSecretConfig is a nested property type of AWS::DataSync::LocationSMB.
`customSecretConfig.secretAccessRoleArn`	string	yes	Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
`customSecretConfig.secretArn`	string	yes	Specifies the ARN for a customer created AWS Secrets Manager secret.
`dnsIpAddresses`	array<string>	—	Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to.
`domain`	string	—	The name of the Windows domain that the SMB server belongs to.
`kerberosKeytab`	string	—	The Base64 string representation of the Keytab file.
`kerberosKrb5Conf`	string	—	The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.
`kerberosPrincipal`	string	—	Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.
`mountOptions`	object	—	DataSyncLocationSMBMountOptions is a nested property type of AWS::DataSync::LocationSMB.
`mountOptions.version`	enum	—	The specific SMB version that you want DataSync to use to mount your SMB share. Allowed: `AUTOMATIC, SMB1, SMB2_0, SMB2, SMB3`
`password`	string	—	The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`serverHostname`	string	—	The name of the SMB server.
`subdirectory`	string	—	The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes
`user`	string	—	The user who can mount the share, has the permissions to access files and folders in the SMB share.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`locationArn`	string	—	The Amazon Resource Name (ARN) of the SMB location that is created.
`locationUri`	string	—	The URL of the SMB location that was described.
`managedSecretConfig`	object	—	Read-only: reported by AWS after creation.
`managedSecretConfig.secretArn`	string	yes	Specifies the ARN for an AWS Secrets Manager secret.
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

DataSyncTask # CLOUD CONTROL · AWS::DataSync::Task

DataSyncTask manages AWS::DataSync::Task through the AWS Cloud Control API.

kubectl get datasynctasks · example on GitHub

Example

# DataSyncTask — DataSync
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/datasync.html#datasynctask
apiVersion: aws.konfig.io/v1alpha1
kind: DataSyncTask
metadata:
  name: example-datasynctask
  namespace: default
spec:
  cloudWatchLogGroupArn: arn:aws:iam::123456789012:role/example-role
  destinationLocationArn: arn:aws:iam::123456789012:role/example-role
  excludes:
  - filterType: SIMPLE_PATTERN
    value: example
  includes:
  - filterType: SIMPLE_PATTERN
    value: example
  manifestConfig:
    action: TRANSFER
    format: CSV
    source:
      s3:
        bucketAccessRoleArn: arn:aws:iam::123456789012:role/example-role
        manifestObjectPath: example
        s3BucketArn: arn:aws:iam::123456789012:role/example-role
  name: example-datasynctask
  options:
    atime: NONE
    bytesPerSecond: 1
    gid: NONE
    logLevel: 'OFF'
    mtime: NONE
    objectTags: PRESERVE
    overwriteMode: ALWAYS
    posixPermissions: NONE
    preserveDeletedFiles: PRESERVE
    preserveDevices: NONE
    securityDescriptorCopyFlags: NONE
    taskQueueing: ENABLED
    transferMode: CHANGED
    uid: NONE
    verifyMode: POINT_IN_TIME_CONSISTENT
  providerRef:
    name: example-datasynctask
    region: us-east-1
  schedule:
    scheduleExpression: example
    status: ENABLED
  sourceLocationArn: arn:aws:iam::123456789012:role/example-role
  tags:
  - key: example
    value: example
  taskMode: BASIC
  taskReportConfig:
    destination:
      s3:
        bucketAccessRoleArn: arn:aws:iam::123456789012:role/example-role
        s3BucketArn: arn:aws:iam::123456789012:role/example-role
        subdirectory: example
    objectVersionIds: INCLUDE
    outputType: SUMMARY_ONLY
    overrides:
      deleted:
        reportLevel: ERRORS_ONLY
      skipped:
        reportLevel: ERRORS_ONLY
      transferred:
        reportLevel: ERRORS_ONLY
      verified:
        reportLevel: ERRORS_ONLY
    reportLevel: ERRORS_ONLY

Spec

Field	Type	Required	Description
`cloudWatchLogGroupArn`	string	—	The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
`destinationLocationArn`	string	yes	The ARN of an AWS storage resource's location.
`excludes`	array<object>	—
`excludes[].filterType`	enum	—	The type of filter rule to apply. Allowed: `SIMPLE_PATTERN`
`excludes[].value`	string	—	A single filter string that consists of the patterns to include or exclude.
`includes`	array<object>	—
`includes[].filterType`	enum	—	The type of filter rule to apply. Allowed: `SIMPLE_PATTERN`
`includes[].value`	string	—	A single filter string that consists of the patterns to include or exclude.
`manifestConfig`	object	—	DataSyncTaskManifestConfig is a nested property type of AWS::DataSync::Task.
`manifestConfig.action`	enum	—	Specifies what DataSync uses the manifest for. Allowed: `TRANSFER`
`manifestConfig.format`	enum	—	Specifies the file format of your manifest. Allowed: `CSV`
`manifestConfig.source`	object	yes	Specifies the manifest that you want DataSync to use and where it's hosted.
`manifestConfig.source.s3`	object	—	DataSyncTaskManifestConfigSourceS3 is a nested property type of AWS::DataSync::Task.
`manifestConfig.source.s3.bucketAccessRoleArn`	string	—	Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
`manifestConfig.source.s3.manifestObjectPath`	string	—	Specifies the Amazon S3 object key of your manifest.
`manifestConfig.source.s3.manifestObjectVersionId`	string	—	Specifies the object version ID of the manifest that you want DataSync to use.
`manifestConfig.source.s3.s3BucketArn`	string	—	Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
`name`	string	—	The name of a task.
`options`	object	—	DataSyncTaskOptions is a nested property type of AWS::DataSync::Task.
`options.atime`	enum	—	A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). Allowed: `NONE, BEST_EFFORT`
`options.bytesPerSecond`	integer	—	A value that limits the bandwidth used by AWS DataSync.
`options.gid`	enum	—	The group ID (GID) of the file's owners. Allowed: `NONE, INT_VALUE, NAME, BOTH`
`options.logLevel`	enum	—	A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. Allowed: `OFF, BASIC, TRANSFER`
`options.mtime`	enum	—	A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. Allowed: `NONE, PRESERVE`
`options.objectTags`	enum	—	A value that determines whether object tags should be read from the source object store and written to the destination object store. Allowed: `PRESERVE, NONE`
`options.overwriteMode`	enum	—	A value that determines whether files at the destination should be overwritten or preserved when copying files. Allowed: `ALWAYS, NEVER`
`options.posixPermissions`	enum	—	A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Allowed: `NONE, PRESERVE`
`options.preserveDeletedFiles`	enum	—	A value that specifies whether files in the destination that don't exist in the source file system should be preserved. Allowed: `PRESERVE, REMOVE`
`options.preserveDevices`	enum	—	A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination. Allowed: `NONE, PRESERVE`
`options.securityDescriptorCopyFlags`	enum	—	A value that determines which components of the SMB security descriptor are copied during transfer. Allowed: `NONE, OWNER_DACL, OWNER_DACL_SACL`
`options.taskQueueing`	enum	—	A value that determines whether tasks should be queued before executing the tasks. Allowed: `ENABLED, DISABLED`
`options.transferMode`	enum	—	A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location. Allowed: `CHANGED, ALL`
`options.uid`	enum	—	The user ID (UID) of the file's owner. Allowed: `NONE, INT_VALUE, NAME, BOTH`
`options.verifyMode`	enum	—	A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Allowed: `POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`schedule`	object	—	DataSyncTaskTaskSchedule is a nested property type of AWS::DataSync::Task.
`schedule.scheduleExpression`	string	—	A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location
`schedule.status`	enum	—	Specifies status of a schedule. Allowed: `ENABLED, DISABLED`
`sourceLocationArn`	string	yes	The ARN of the source location for the task.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes
`taskMode`	enum	—	Specifies the task mode for the task. Allowed: `BASIC, ENHANCED`
`taskReportConfig`	object	—	DataSyncTaskTaskReportConfig is a nested property type of AWS::DataSync::Task.
`taskReportConfig.destination`	object	yes	Specifies where DataSync uploads your task report.
`taskReportConfig.destination.s3`	object	—	DataSyncTaskTaskReportConfigDestinationS3 is a nested property type of AWS::DataSync::Task.
`taskReportConfig.destination.s3.bucketAccessRoleArn`	string	—	Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.
`taskReportConfig.destination.s3.s3BucketArn`	string	—	Specifies the ARN of the S3 bucket where Datasync uploads your report.
`taskReportConfig.destination.s3.subdirectory`	string	—	Specifies a bucket prefix for your report.
`taskReportConfig.objectVersionIds`	enum	—	Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket. Allowed: `INCLUDE, NONE`
`taskReportConfig.outputType`	enum	yes	Specifies the type of task report that you want. Allowed: `SUMMARY_ONLY, STANDARD`
`taskReportConfig.overrides`	object	—	Customizes the reporting level for aspects of your task report.
`taskReportConfig.overrides.deleted`	object	—	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location.
`taskReportConfig.overrides.deleted.reportLevel`	enum	—	Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. Allowed: `ERRORS_ONLY, SUCCESSES_AND_ERRORS`
`taskReportConfig.overrides.skipped`	object	—	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
`taskReportConfig.overrides.skipped.reportLevel`	enum	—	Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. Allowed: `ERRORS_ONLY, SUCCESSES_AND_ERRORS`
`taskReportConfig.overrides.transferred`	object	—	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
`taskReportConfig.overrides.transferred.reportLevel`	enum	—	Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. Allowed: `ERRORS_ONLY, SUCCESSES_AND_ERRORS`
`taskReportConfig.overrides.verified`	object	—	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer.
`taskReportConfig.overrides.verified.reportLevel`	enum	—	Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. Allowed: `ERRORS_ONLY, SUCCESSES_AND_ERRORS`
`taskReportConfig.reportLevel`	enum	—	Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. Allowed: `ERRORS_ONLY, SUCCESSES_AND_ERRORS`

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`destinationNetworkInterfaceArns`	array<string>	—	Read-only: reported by AWS after creation.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`sourceNetworkInterfaceArns`	array<string>	—	Read-only: reported by AWS after creation.
`status`	enum	—	The status of the task that was described. Allowed: `AVAILABLE, CREATING, QUEUED, RUNNING, UNAVAILABLE`
`taskArn`	string	—	The ARN of the task.