We recommend new projects start with resources from the AWS provider.
aws-native.datasync.LocationObjectStorage
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::DataSync::LocationObjectStorage.
Example Usage
Example
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;
return await Deployment.RunAsync(() => 
{
    var locationObjectStorage = new AwsNative.DataSync.LocationObjectStorage("locationObjectStorage", new()
    {
        AgentArns = new[]
        {
            "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs",
        },
        BucketName = "MyBucket",
        ServerHostname = "MyServer@example.com",
        ServerProtocol = AwsNative.DataSync.LocationObjectStorageServerProtocol.Https,
        Subdirectory = "/MySubdirectory",
    });
});
package main
import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/datasync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasync.NewLocationObjectStorage(ctx, "locationObjectStorage", &datasync.LocationObjectStorageArgs{
			AgentArns: pulumi.StringArray{
				pulumi.String("arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs"),
			},
			BucketName:     pulumi.String("MyBucket"),
			ServerHostname: pulumi.String("MyServer@example.com"),
			ServerProtocol: datasync.LocationObjectStorageServerProtocolHttps,
			Subdirectory:   pulumi.String("/MySubdirectory"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Example coming soon!
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";
const locationObjectStorage = new aws_native.datasync.LocationObjectStorage("locationObjectStorage", {
    agentArns: ["arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs"],
    bucketName: "MyBucket",
    serverHostname: "MyServer@example.com",
    serverProtocol: aws_native.datasync.LocationObjectStorageServerProtocol.Https,
    subdirectory: "/MySubdirectory",
});
import pulumi
import pulumi_aws_native as aws_native
location_object_storage = aws_native.datasync.LocationObjectStorage("locationObjectStorage",
    agent_arns=["arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs"],
    bucket_name="MyBucket",
    server_hostname="MyServer@example.com",
    server_protocol=aws_native.datasync.LocationObjectStorageServerProtocol.HTTPS,
    subdirectory="/MySubdirectory")
Example coming soon!
Create LocationObjectStorage Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LocationObjectStorage(name: string, args?: LocationObjectStorageArgs, opts?: CustomResourceOptions);@overload
def LocationObjectStorage(resource_name: str,
                          args: Optional[LocationObjectStorageArgs] = None,
                          opts: Optional[ResourceOptions] = None)
@overload
def LocationObjectStorage(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          access_key: Optional[str] = None,
                          agent_arns: Optional[Sequence[str]] = None,
                          bucket_name: Optional[str] = None,
                          cmk_secret_config: Optional[LocationObjectStorageCmkSecretConfigArgs] = None,
                          custom_secret_config: Optional[LocationObjectStorageCustomSecretConfigArgs] = None,
                          secret_key: Optional[str] = None,
                          server_certificate: Optional[str] = None,
                          server_hostname: Optional[str] = None,
                          server_port: Optional[int] = None,
                          server_protocol: Optional[LocationObjectStorageServerProtocol] = None,
                          subdirectory: Optional[str] = None,
                          tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewLocationObjectStorage(ctx *Context, name string, args *LocationObjectStorageArgs, opts ...ResourceOption) (*LocationObjectStorage, error)public LocationObjectStorage(string name, LocationObjectStorageArgs? args = null, CustomResourceOptions? opts = null)
public LocationObjectStorage(String name, LocationObjectStorageArgs args)
public LocationObjectStorage(String name, LocationObjectStorageArgs args, CustomResourceOptions options)
type: aws-native:datasync:LocationObjectStorage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args LocationObjectStorageArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args LocationObjectStorageArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args LocationObjectStorageArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LocationObjectStorageArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LocationObjectStorageArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
LocationObjectStorage Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The LocationObjectStorage resource accepts the following input properties:
- AccessKey string
- Optional. The access key is used if credentials are required to access the self-managed object storage server.
- AgentArns List<string>
- 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.
- BucketName string
- The name of the bucket on the self-managed object storage server.
- CmkSecret Pulumi.Config Aws Native. Data Sync. Inputs. Location Object Storage Cmk Secret Config 
- Specifies configuration information for a DataSync-managed secret, which includes the - SecretKeythat DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .- When you include this paramater as part of a - CreateLocationObjectStoragerequest, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the- SecretKeyparameter to create a DataSync-managed secret to store the location access credentials.- Make sure the DataSync has permission to access the KMS key that you specify. - You can use either - CmkSecretConfig(with- SecretKey) or- CustomSecretConfig(without- SecretKey) to provide credentials for a- CreateLocationObjectStoragerequest. Do not provide both parameters for the same request.
- CustomSecret Pulumi.Config Aws Native. Data Sync. Inputs. Location Object Storage Custom Secret Config 
- Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. - You can use either - CmkSecretConfig(with- SecretKey) or- CustomSecretConfig(without- SecretKey) to provide credentials for a- CreateLocationObjectStoragerequest. Do not provide both parameters for the same request.
- SecretKey string
- Optional. The secret key is used if credentials are required to access the self-managed object storage server.
- 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. This value is the IP address or Domain Name Service (DNS) name of the object storage server.
- ServerPort int
- The port that your self-managed server accepts inbound network traffic on.
- ServerProtocol Pulumi.Aws Native. Data Sync. Location Object Storage Server Protocol 
- The protocol that the object storage server uses to communicate.
- Subdirectory string
- The subdirectory in the self-managed object storage server that is used to read data from.
- 
List<Pulumi.Aws Native. Inputs. Tag> 
- An array of key-value pairs to apply to this resource.
- AccessKey string
- Optional. The access key is used if credentials are required to access the self-managed object storage server.
- AgentArns []string
- 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.
- BucketName string
- The name of the bucket on the self-managed object storage server.
- CmkSecret LocationConfig Object Storage Cmk Secret Config Args 
- Specifies configuration information for a DataSync-managed secret, which includes the - SecretKeythat DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .- When you include this paramater as part of a - CreateLocationObjectStoragerequest, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the- SecretKeyparameter to create a DataSync-managed secret to store the location access credentials.- Make sure the DataSync has permission to access the KMS key that you specify. - You can use either - CmkSecretConfig(with- SecretKey) or- CustomSecretConfig(without- SecretKey) to provide credentials for a- CreateLocationObjectStoragerequest. Do not provide both parameters for the same request.
- CustomSecret LocationConfig Object Storage Custom Secret Config Args 
- Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. - You can use either - CmkSecretConfig(with- SecretKey) or- CustomSecretConfig(without- SecretKey) to provide credentials for a- CreateLocationObjectStoragerequest. Do not provide both parameters for the same request.
- SecretKey string
- Optional. The secret key is used if credentials are required to access the self-managed object storage server.
- 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. This value is the IP address or Domain Name Service (DNS) name of the object storage server.
- ServerPort int
- The port that your self-managed server accepts inbound network traffic on.
- ServerProtocol LocationObject Storage Server Protocol 
- The protocol that the object storage server uses to communicate.
- Subdirectory string
- The subdirectory in the self-managed object storage server that is used to read data from.
- 
TagArgs 
- An array of key-value pairs to apply to this resource.
- accessKey String
- Optional. The access key is used if credentials are required to access the self-managed object storage server.
- agentArns List<String>
- 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.
- bucketName String
- The name of the bucket on the self-managed object storage server.
- cmkSecret LocationConfig Object Storage Cmk Secret Config 
- Specifies configuration information for a DataSync-managed secret, which includes the - SecretKeythat DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .- When you include this paramater as part of a - CreateLocationObjectStoragerequest, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the- SecretKeyparameter to create a DataSync-managed secret to store the location access credentials.- Make sure the DataSync has permission to access the KMS key that you specify. - You can use either - CmkSecretConfig(with- SecretKey) or- CustomSecretConfig(without- SecretKey) to provide credentials for a- CreateLocationObjectStoragerequest. Do not provide both parameters for the same request.
- customSecret LocationConfig Object Storage Custom Secret Config 
- Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. - You can use either - CmkSecretConfig(with- SecretKey) or- CustomSecretConfig(without- SecretKey) to provide credentials for a- CreateLocationObjectStoragerequest. Do not provide both parameters for the same request.
- secretKey String
- Optional. The secret key is used if credentials are required to access the self-managed object storage server.
- 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. This value is the IP address or Domain Name Service (DNS) name of the object storage server.
- serverPort Integer
- The port that your self-managed server accepts inbound network traffic on.
- serverProtocol LocationObject Storage Server Protocol 
- The protocol that the object storage server uses to communicate.
- subdirectory String
- The subdirectory in the self-managed object storage server that is used to read data from.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- accessKey string
- Optional. The access key is used if credentials are required to access the self-managed object storage server.
- agentArns string[]
- 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.
- bucketName string
- The name of the bucket on the self-managed object storage server.
- cmkSecret LocationConfig Object Storage Cmk Secret Config 
- Specifies configuration information for a DataSync-managed secret, which includes the - SecretKeythat DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .- When you include this paramater as part of a - CreateLocationObjectStoragerequest, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the- SecretKeyparameter to create a DataSync-managed secret to store the location access credentials.- Make sure the DataSync has permission to access the KMS key that you specify. - You can use either - CmkSecretConfig(with- SecretKey) or- CustomSecretConfig(without- SecretKey) to provide credentials for a- CreateLocationObjectStoragerequest. Do not provide both parameters for the same request.
- customSecret LocationConfig Object Storage Custom Secret Config 
- Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. - You can use either - CmkSecretConfig(with- SecretKey) or- CustomSecretConfig(without- SecretKey) to provide credentials for a- CreateLocationObjectStoragerequest. Do not provide both parameters for the same request.
- secretKey string
- Optional. The secret key is used if credentials are required to access the self-managed object storage server.
- 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. This value is the IP address or Domain Name Service (DNS) name of the object storage server.
- serverPort number
- The port that your self-managed server accepts inbound network traffic on.
- serverProtocol LocationObject Storage Server Protocol 
- The protocol that the object storage server uses to communicate.
- subdirectory string
- The subdirectory in the self-managed object storage server that is used to read data from.
- Tag[]
- An array of key-value pairs to apply to this resource.
- access_key str
- Optional. The access key is used if credentials are required to access the self-managed object storage server.
- agent_arns Sequence[str]
- 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.
- bucket_name str
- The name of the bucket on the self-managed object storage server.
- cmk_secret_ Locationconfig Object Storage Cmk Secret Config Args 
- Specifies configuration information for a DataSync-managed secret, which includes the - SecretKeythat DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .- When you include this paramater as part of a - CreateLocationObjectStoragerequest, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the- SecretKeyparameter to create a DataSync-managed secret to store the location access credentials.- Make sure the DataSync has permission to access the KMS key that you specify. - You can use either - CmkSecretConfig(with- SecretKey) or- CustomSecretConfig(without- SecretKey) to provide credentials for a- CreateLocationObjectStoragerequest. Do not provide both parameters for the same request.
- custom_secret_ Locationconfig Object Storage Custom Secret Config Args 
- Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. - You can use either - CmkSecretConfig(with- SecretKey) or- CustomSecretConfig(without- SecretKey) to provide credentials for a- CreateLocationObjectStoragerequest. Do not provide both parameters for the same request.
- secret_key str
- Optional. The secret key is used if credentials are required to access the self-managed object storage server.
- server_certificate str
- X.509 PEM content containing a certificate authority or chain to trust.
- server_hostname str
- The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server.
- server_port int
- The port that your self-managed server accepts inbound network traffic on.
- server_protocol LocationObject Storage Server Protocol 
- The protocol that the object storage server uses to communicate.
- subdirectory str
- The subdirectory in the self-managed object storage server that is used to read data from.
- 
Sequence[TagArgs] 
- An array of key-value pairs to apply to this resource.
- accessKey String
- Optional. The access key is used if credentials are required to access the self-managed object storage server.
- agentArns List<String>
- 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.
- bucketName String
- The name of the bucket on the self-managed object storage server.
- cmkSecret Property MapConfig 
- Specifies configuration information for a DataSync-managed secret, which includes the - SecretKeythat DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .- When you include this paramater as part of a - CreateLocationObjectStoragerequest, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the- SecretKeyparameter to create a DataSync-managed secret to store the location access credentials.- Make sure the DataSync has permission to access the KMS key that you specify. - You can use either - CmkSecretConfig(with- SecretKey) or- CustomSecretConfig(without- SecretKey) to provide credentials for a- CreateLocationObjectStoragerequest. Do not provide both parameters for the same request.
- customSecret Property MapConfig 
- Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. - You can use either - CmkSecretConfig(with- SecretKey) or- CustomSecretConfig(without- SecretKey) to provide credentials for a- CreateLocationObjectStoragerequest. Do not provide both parameters for the same request.
- secretKey String
- Optional. The secret key is used if credentials are required to access the self-managed object storage server.
- 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. This value is the IP address or Domain Name Service (DNS) name of the object storage server.
- serverPort Number
- The port that your self-managed server accepts inbound network traffic on.
- serverProtocol "HTTPS" | "HTTP"
- The protocol that the object storage server uses to communicate.
- subdirectory String
- The subdirectory in the self-managed object storage server that is used to read data from.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the LocationObjectStorage resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- 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.
- ManagedSecret Pulumi.Config Aws Native. Data Sync. Outputs. Location Object Storage Managed Secret Config 
- Id string
- The provider-assigned unique ID for this managed resource.
- 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.
- ManagedSecret LocationConfig Object Storage Managed Secret Config 
- id String
- The provider-assigned unique ID for this managed resource.
- 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.
- managedSecret LocationConfig Object Storage Managed Secret Config 
- id string
- The provider-assigned unique ID for this managed resource.
- 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.
- managedSecret LocationConfig Object Storage Managed Secret Config 
- id str
- The provider-assigned unique ID for this managed resource.
- location_arn str
- The Amazon Resource Name (ARN) of the location that is created.
- location_uri str
- The URL of the object storage location that was described.
- managed_secret_ Locationconfig Object Storage Managed Secret Config 
- id String
- The provider-assigned unique ID for this managed resource.
- 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.
- managedSecret Property MapConfig 
Supporting Types
LocationObjectStorageCmkSecretConfig, LocationObjectStorageCmkSecretConfigArgs            
Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.- kms_key_ strarn 
- Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager.
- secret_arn str
- Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
LocationObjectStorageCustomSecretConfig, LocationObjectStorageCustomSecretConfigArgs            
Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.- SecretAccess stringRole Arn 
- Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
- SecretArn string
- Specifies the ARN for a customer created AWS Secrets Manager secret.
- SecretAccess stringRole Arn 
- Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
- SecretArn string
- Specifies the ARN for a customer created AWS Secrets Manager secret.
- secretAccess StringRole Arn 
- Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
- secretArn String
- Specifies the ARN for a customer created AWS Secrets Manager secret.
- secretAccess stringRole Arn 
- Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
- secretArn string
- Specifies the ARN for a customer created AWS Secrets Manager secret.
- secret_access_ strrole_ arn 
- Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
- secret_arn str
- Specifies the ARN for a customer created AWS Secrets Manager secret.
- secretAccess StringRole Arn 
- Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
- secretArn String
- Specifies the ARN for a customer created AWS Secrets Manager secret.
LocationObjectStorageManagedSecretConfig, LocationObjectStorageManagedSecretConfigArgs            
Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.- SecretArn string
- Specifies the ARN for an AWS Secrets Manager secret.
- SecretArn string
- Specifies the ARN for an AWS Secrets Manager secret.
- secretArn String
- Specifies the ARN for an AWS Secrets Manager secret.
- secretArn string
- Specifies the ARN for an AWS Secrets Manager secret.
- secret_arn str
- Specifies the ARN for an AWS Secrets Manager secret.
- secretArn String
- Specifies the ARN for an AWS Secrets Manager secret.
LocationObjectStorageServerProtocol, LocationObjectStorageServerProtocolArgs          
- Https
- HTTPS
- Http
- HTTP
- LocationObject Storage Server Protocol Https 
- HTTPS
- LocationObject Storage Server Protocol Http 
- HTTP
- Https
- HTTPS
- Http
- HTTP
- Https
- HTTPS
- Http
- HTTP
- HTTPS
- HTTPS
- HTTP
- HTTP
- "HTTPS"
- HTTPS
- "HTTP"
- HTTP
Tag, TagArgs  
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
