Input only. AWS access key used to sign the API requests to the AWS S3
bucket. Permissions on the bucket must be granted to the access ID of the
AWS access key. This field is required.
For information on our data retention policy for user credentials, see
User credentials.
Must be an empty string or full path name that ends with a '/'. This field
is treated as an object prefix. As such, it should generally not begin with
a '/'.
Input only. Role arn to support temporary credentials via
AssumeRoleWithWebIdentity.
When role arn is provided, transfer service will fetch temporary
credentials for the session using AssumeRoleWithWebIdentity call for the
provided role using the [GoogleServiceAccount] for this project.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eAwsS3Data\u003c/code\u003e class is designed to represent data from an AWS S3 bucket in the Google Cloud Storage Transfer Service, acting as a data source but not a data sink.\u003c/p\u003e\n"],["\u003cp\u003eThis class provides access to various versions, with the latest being version 2.8.0, and also includes methods for constructing \u003ccode\u003eAwsS3Data\u003c/code\u003e objects.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAwsS3Data\u003c/code\u003e objects must specify the S3 bucket name (\u003ccode\u003eBucketName\u003c/code\u003e), can optionally specify a root path (\u003ccode\u003ePath\u003c/code\u003e), and can use either AWS access keys (\u003ccode\u003eAwsAccessKey\u003c/code\u003e) or temporary credentials via a role ARN (\u003ccode\u003eRoleArn\u003c/code\u003e) for authentication.\u003c/p\u003e\n"],["\u003cp\u003eAn object's name within an \u003ccode\u003eAwsS3Data\u003c/code\u003e resource is defined by its S3 object's key name, while utilizing various interfaces and inheritance from \u003ccode\u003eObject\u003c/code\u003e and implementing \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e for core functionality.\u003c/p\u003e\n"],["\u003cp\u003eThe class \u003ccode\u003eAwsS3Data\u003c/code\u003e contains several properties, including \u003ccode\u003eAwsAccessKey\u003c/code\u003e, \u003ccode\u003eBucketName\u003c/code\u003e, \u003ccode\u003ePath\u003c/code\u003e, and \u003ccode\u003eRoleArn\u003c/code\u003e, which are used to describe the data, to authenticate, and to specify the source, to interact with AWS S3 buckets.\u003c/p\u003e\n"]]],[],null,[]]
