Skip to content

Commit 3d73a06

Browse files
author
AWS
committed
AWS DataSync Update: Added S3StorageClass, OverwriteMode sync option, and ONLY_FILES_TRANSFERRED setting for the VerifyMode sync option.
1 parent 91674e1 commit 3d73a06

File tree

2 files changed

+53
-14
lines changed

2 files changed

+53
-14
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS DataSync",
4+
"description": "Added S3StorageClass, OverwriteMode sync option, and ONLY_FILES_TRANSFERRED setting for the VerifyMode sync option."
5+
}

services/datasync/src/main/resources/codegen-resources/service-2.json

Lines changed: 48 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
{"shape":"InvalidRequestException"},
8383
{"shape":"InternalException"}
8484
],
85-
"documentation":"<p>Creates an endpoint for an Amazon S3 bucket.</p> <p>For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.</p> <p>For more information, see Configuring Amazon S3 Location Settings in the <i>AWS DataSync User Guide.</i> </p>"
85+
"documentation":"<p>Creates an endpoint for an Amazon S3 bucket.</p> <p>For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.</p> <p>For more information, see https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location in the <i>AWS DataSync User Guide.</i> </p>"
8686
},
8787
"CreateLocationSmb":{
8888
"name":"CreateLocationSmb",
@@ -488,7 +488,7 @@
488488
},
489489
"SubnetArns":{
490490
"shape":"PLSubnetArnList",
491-
"documentation":"<p>The Amazon Resource Names (ARNs) of the subnets in which DataSync will create Elastic Network Interfaces (ENIs) for each data transfer task. The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four ENIs for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four ENIs.</p>"
491+
"documentation":"<p>The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task. The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four network interfaces.</p>"
492492
},
493493
"SecurityGroupArns":{
494494
"shape":"PLSecurityGroupArnList",
@@ -599,6 +599,10 @@
599599
"shape":"S3BucketArn",
600600
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon S3 bucket.</p>"
601601
},
602+
"S3StorageClass":{
603+
"shape":"S3StorageClass",
604+
"documentation":"<p>The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For more information about S3 storage classes, see <a href=\"https://aws.amazon.com/s3/storage-classes/\">Amazon S3 Storage Classes</a> in the <i>Amazon Simple Storage Service Developer Guide</i>. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see <a>using-storage-classes</a>.</p>"
605+
},
602606
"S3Config":{"shape":"S3Config"},
603607
"Tags":{
604608
"shape":"TagList",
@@ -633,27 +637,27 @@
633637
},
634638
"ServerHostname":{
635639
"shape":"ServerHostname",
636-
"documentation":"<p>The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this host name to mount the SMB server in a network.</p> <note> <p>This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.</p> </note>"
640+
"documentation":"<p>The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.</p> <note> <p>This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.</p> </note>"
637641
},
638642
"User":{
639643
"shape":"SmbUser",
640-
"documentation":"<p>The user who can mount the share, has the permissions to access files and directories in the SMB share.</p>"
644+
"documentation":"<p>The user who can mount the share, has the permissions to access files and folders in the SMB share.</p>"
641645
},
642646
"Domain":{
643647
"shape":"SmbDomain",
644-
"documentation":"<p>The name of the domain that the SMB server belongs to.</p>"
648+
"documentation":"<p>The name of the Windows domain that the SMB server belongs to.</p>"
645649
},
646650
"Password":{
647651
"shape":"SmbPassword",
648-
"documentation":"<p>The password of the user who has permission to access the SMB server.</p>"
652+
"documentation":"<p>The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.</p>"
649653
},
650654
"AgentArns":{
651655
"shape":"AgentArnList",
652656
"documentation":"<p>The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location. </p>"
653657
},
654658
"MountOptions":{
655659
"shape":"SmbMountOptions",
656-
"documentation":"<p>The mount options that are available for DataSync to use to access an SMB location.</p>"
660+
"documentation":"<p>The mount options used by DataSync to access the SMB server.</p>"
657661
},
658662
"Tags":{
659663
"shape":"TagList",
@@ -806,7 +810,10 @@
806810
"shape":"EndpointType",
807811
"documentation":"<p>The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public Internet. </p>"
808812
},
809-
"PrivateLinkConfig":{"shape":"PrivateLinkConfig"}
813+
"PrivateLinkConfig":{
814+
"shape":"PrivateLinkConfig",
815+
"documentation":"<p>The subnet and the security group that DataSync used to access a VPC endpoint.</p>"
816+
}
810817
},
811818
"documentation":"<p>DescribeAgentResponse</p>"
812819
},
@@ -896,6 +903,10 @@
896903
"shape":"LocationUri",
897904
"documentation":"<p>The URL of the Amazon S3 location that was described.</p>"
898905
},
906+
"S3StorageClass":{
907+
"shape":"S3StorageClass",
908+
"documentation":"<p>The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see <a href=\"https://aws.amazon.com/s3/storage-classes/\">Amazon S3 Storage Classes</a> in the <i>Amazon Simple Storage Service Developer Guide</i>. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see <a>using-storage-classes</a>.</p>"
909+
},
899910
"S3Config":{"shape":"S3Config"},
900911
"CreationTime":{
901912
"shape":"Time",
@@ -932,11 +943,11 @@
932943
},
933944
"User":{
934945
"shape":"SmbUser",
935-
"documentation":"<p>The user who is logged on the SMB server.</p>"
946+
"documentation":"<p>The user who can mount the share, has the permissions to access files and folders in the SMB share.</p>"
936947
},
937948
"Domain":{
938949
"shape":"SmbDomain",
939-
"documentation":"<p>The name of the domain that the SMB server belongs to.</p>"
950+
"documentation":"<p>The name of the Windows domain that the SMB server belongs to.</p>"
940951
},
941952
"MountOptions":{
942953
"shape":"SmbMountOptions",
@@ -1417,7 +1428,7 @@
14171428
"members":{
14181429
"Version":{
14191430
"shape":"NfsVersion",
1420-
"documentation":"<p>The specific NFS version that you want DataSync to use to mount your NFS share. If you don't specify a version, DataSync defaults to <code>AUTOMATIC</code>. That is, DataSync automatically selects a version based on negotiation with the NFS server.</p>"
1431+
"documentation":"<p>The specific NFS version that you want DataSync to use to mount your NFS share. If the server refuses to use the version specified, the sync will fail. If you don't specify a version, DataSync defaults to <code>AUTOMATIC</code>. That is, DataSync automatically selects a version based on negotiation with the NFS server.</p> <p>You can specify the following NFS versions:</p> <ul> <li> <p> <b> <a href=\"https://tools.ietf.org/html/rfc1813\">NFSv3</a> </b> - stateless protocol version that allows for asynchronous writes on the server.</p> </li> <li> <p> <b> <a href=\"https://tools.ietf.org/html/rfc3530\">NFSv4.0</a> </b> - stateful, firewall-friendly protocol version that supports delegations and pseudo filesystems.</p> </li> <li> <p> <b> <a href=\"https://tools.ietf.org/html/rfc5661\">NFSv4.1</a> </b> - stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.</p> </li> </ul>"
14211432
}
14221433
},
14231434
"documentation":"<p>Represents the mount options that are available for DataSync to access an NFS location.</p>"
@@ -1452,7 +1463,11 @@
14521463
"members":{
14531464
"VerifyMode":{
14541465
"shape":"VerifyMode",
1455-
"documentation":"<p>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. </p> <p>Default value: POINT_IN_TIME_CONSISTENT.</p> <p>POINT_IN_TIME_CONSISTENT: Perform verification (recommended). </p> <p>NONE: Skip verification.</p>"
1466+
"documentation":"<p>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. </p> <p>Default value: POINT_IN_TIME_CONSISTENT.</p> <p>POINT_IN_TIME_CONSISTENT: Perform verification (recommended). </p> <p>ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred.</p> <p>NONE: Skip verification.</p>"
1467+
},
1468+
"OverwriteMode":{
1469+
"shape":"OverwriteMode",
1470+
"documentation":"<p>A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to <code>NEVER</code> a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes. </p> <p>Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see <a>using-storage-classes</a> in the <i>AWS DataSync User Guide</i>.</p>"
14561471
},
14571472
"Atime":{
14581473
"shape":"Atime",
@@ -1472,7 +1487,7 @@
14721487
},
14731488
"PreserveDeletedFiles":{
14741489
"shape":"PreserveDeletedFiles",
1475-
"documentation":"<p>A value that specifies whether files in the destination that don't exist in the source file system should be preserved. </p> <p>Default value: PRESERVE.</p> <p>PRESERVE: Ignore such destination files (recommended). </p> <p>REMOVE: Delete destination files that aren’t present in the source.</p>"
1490+
"documentation":"<p>A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see <a>using-storage-classes</a> in the <i>AWS DataSync User Guide</i>.</p> <p>Default value: PRESERVE.</p> <p>PRESERVE: Ignore such destination files (recommended). </p> <p>REMOVE: Delete destination files that aren’t present in the source.</p>"
14761491
},
14771492
"PreserveDevices":{
14781493
"shape":"PreserveDevices",
@@ -1489,6 +1504,13 @@
14891504
},
14901505
"documentation":"<p>Represents the options that are available to control the behavior of a <a>StartTaskExecution</a> operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.</p> <p>A task has a set of default options associated with it. If you don't specify an option in <a>StartTaskExecution</a>, the default value is used. You can override the defaults options on each task execution by specifying an overriding <code>Options</code> value to <a>StartTaskExecution</a>.</p>"
14911506
},
1507+
"OverwriteMode":{
1508+
"type":"string",
1509+
"enum":[
1510+
"ALWAYS",
1511+
"NEVER"
1512+
]
1513+
},
14921514
"PLSecurityGroupArnList":{
14931515
"type":"list",
14941516
"member":{"shape":"Ec2SecurityGroupArn"},
@@ -1569,6 +1591,17 @@
15691591
},
15701592
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.</p> <p>For detailed information about using such a role, see Creating a Location for Amazon S3 in the <i>AWS DataSync User Guide</i>.</p>"
15711593
},
1594+
"S3StorageClass":{
1595+
"type":"string",
1596+
"enum":[
1597+
"STANDARD",
1598+
"STANDARD_IA",
1599+
"ONEZONE_IA",
1600+
"INTELLIGENT_TIERING",
1601+
"GLACIER",
1602+
"DEEP_ARCHIVE"
1603+
]
1604+
},
15721605
"ServerHostname":{
15731606
"type":"string",
15741607
"max":255,
@@ -1584,7 +1617,7 @@
15841617
"members":{
15851618
"Version":{
15861619
"shape":"SmbVersion",
1587-
"documentation":"<p>The specific SMB version that you want DataSync to use to mount your SMB share. If you don't specify a version, DataSync defaults to <code>AUTOMATIC</code>. That is, DataSync automatically selects a version based on negotiation with the SMB Server server.</p>"
1620+
"documentation":"<p>The specific SMB version that you want DataSync to use to mount your SMB share. If you don't specify a version, DataSync defaults to <code>AUTOMATIC</code>. That is, DataSync automatically selects a version based on negotiation with the SMB server.</p>"
15881621
}
15891622
},
15901623
"documentation":"<p>Represents the mount options that are available for DataSync to access an SMB location.</p>"
@@ -1903,6 +1936,7 @@
19031936
"type":"string",
19041937
"enum":[
19051938
"POINT_IN_TIME_CONSISTENT",
1939+
"ONLY_FILES_TRANSFERRED",
19061940
"NONE"
19071941
]
19081942
},

0 commit comments

Comments
 (0)