(Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | AgentArns |
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Specifies the name of the object storage bucket involved in the transfer.
| Required? | True |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.If you provide a secret using SecretKey, but do not provide secret configuration details using CmkSecretConfig or CustomSecretConfig, then DataSync stores the token using your Amazon Web Services account's Secrets Manager secret.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Amazon.PowerShell.Cmdlets.DSYN.AmazonDataSyncClientCmdlet.ClientConfig
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-CmkSecretConfig_KmsKeyArn <
String>
Specifies the ARN for the customer-managed KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn. DataSync provides this key to Secrets Manager.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-CmkSecretConfig_SecretArn <
String>
Specifies the ARN for the DataSync-managed Secrets Manager secret that that is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-CustomSecretConfig_SecretAccessRoleArn <
String>
Specifies the ARN for the Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-CustomSecretConfig_SecretArn <
String>
Specifies the ARN for an Secrets Manager secret.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is 'LocationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.CreateLocationObjectStorageResponse). Specifying the name of a property of type Amazon.DataSync.Model.CreateLocationObjectStorageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single
.pem file with a full certificate chain (for example,
file:///home/user/.ssh/object_storage_certificates.pem).The certificate chain might include:
- The object storage system's certificate
- All intermediate certificates (if there are any)
- The root certificate of the signing CA
You can concatenate your certificates into a
.pem file (which can be up to 32768 bytes before base64 encoding). The following example
cat command creates an
object_storage_certificates.pem file that includes three certificates:
cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pemTo use this parameter, configure
ServerProtocol to
HTTPS.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to.
| Required? | True |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Specifies the protocol that your object storage server uses to communicate. If not specified, the default value is HTTPS.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | Tags |