Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. datasync
  5. LocationObjectStorage
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.datasync.LocationObjectStorage

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Manages a Object Storage Location within AWS DataSync.

    NOTE: The DataSync Agents must be available before creating this resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.datasync.LocationObjectStorage("example", {
    agentArns: [exampleAwsDatasyncAgent.arn],
    serverHostname: "example",
    bucketName: "example",
});

    import pulumi
import pulumi_aws as aws

example = aws.datasync.LocationObjectStorage("example",
    agent_arns=[example_aws_datasync_agent["arn"]],
    server_hostname="example",
    bucket_name="example")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/datasync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasync.NewLocationObjectStorage(ctx, "example", &datasync.LocationObjectStorageArgs{
			AgentArns: pulumi.StringArray{
				exampleAwsDatasyncAgent.Arn,
			},
			ServerHostname: pulumi.String("example"),
			BucketName:     pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DataSync.LocationObjectStorage("example", new()
    {
        AgentArns = new[]
        {
            exampleAwsDatasyncAgent.Arn,
        },
        ServerHostname = "example",
        BucketName = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.datasync.LocationObjectStorage;
import com.pulumi.aws.datasync.LocationObjectStorageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new LocationObjectStorage("example", LocationObjectStorageArgs.builder()
            .agentArns(exampleAwsDatasyncAgent.arn())
            .serverHostname("example")
            .bucketName("example")
            .build());

    }
}

    resources:
  example:
    type: aws:datasync:LocationObjectStorage
    properties:
      agentArns:
        - ${exampleAwsDatasyncAgent.arn}
      serverHostname: example
      bucketName: example

    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: LocationObjectStorageArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def LocationObjectStorage(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          agent_arns: Optional[Sequence[str]] = None,
                          bucket_name: Optional[str] = None,
                          server_hostname: Optional[str] = None,
                          access_key: Optional[str] = None,
                          secret_key: Optional[str] = None,
                          server_certificate: Optional[str] = None,
                          server_port: Optional[int] = None,
                          server_protocol: Optional[str] = None,
                          subdirectory: Optional[str] = None,
                          tags: Optional[Mapping[str, str]] = None)
    func NewLocationObjectStorage(ctx *Context, name string, args LocationObjectStorageArgs, opts ...ResourceOption) (*LocationObjectStorage, error)
    public LocationObjectStorage(string name, LocationObjectStorageArgs args, CustomResourceOptions? opts = null)
    public LocationObjectStorage(String name, LocationObjectStorageArgs args)
public LocationObjectStorage(String name, LocationObjectStorageArgs args, CustomResourceOptions options)

    type: aws: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var locationObjectStorageResource = new Aws.DataSync.LocationObjectStorage("locationObjectStorageResource", new()
{
    AgentArns = new[]
    {
        "string",
    },
    BucketName = "string",
    ServerHostname = "string",
    AccessKey = "string",
    SecretKey = "string",
    ServerCertificate = "string",
    ServerPort = 0,
    ServerProtocol = "string",
    Subdirectory = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := datasync.NewLocationObjectStorage(ctx, "locationObjectStorageResource", &datasync.LocationObjectStorageArgs{
	AgentArns: pulumi.StringArray{
		pulumi.String("string"),
	},
	BucketName:        pulumi.String("string"),
	ServerHostname:    pulumi.String("string"),
	AccessKey:         pulumi.String("string"),
	SecretKey:         pulumi.String("string"),
	ServerCertificate: pulumi.String("string"),
	ServerPort:        pulumi.Int(0),
	ServerProtocol:    pulumi.String("string"),
	Subdirectory:      pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var locationObjectStorageResource = new LocationObjectStorage("locationObjectStorageResource", LocationObjectStorageArgs.builder()
    .agentArns("string")
    .bucketName("string")
    .serverHostname("string")
    .accessKey("string")
    .secretKey("string")
    .serverCertificate("string")
    .serverPort(0)
    .serverProtocol("string")
    .subdirectory("string")
    .tags(Map.of("string", "string"))
    .build());

    location_object_storage_resource = aws.datasync.LocationObjectStorage("locationObjectStorageResource",
    agent_arns=["string"],
    bucket_name="string",
    server_hostname="string",
    access_key="string",
    secret_key="string",
    server_certificate="string",
    server_port=0,
    server_protocol="string",
    subdirectory="string",
    tags={
        "string": "string",
    })

    const locationObjectStorageResource = new aws.datasync.LocationObjectStorage("locationObjectStorageResource", {
    agentArns: ["string"],
    bucketName: "string",
    serverHostname: "string",
    accessKey: "string",
    secretKey: "string",
    serverCertificate: "string",
    serverPort: 0,
    serverProtocol: "string",
    subdirectory: "string",
    tags: {
        string: "string",
    },
});

    type: aws:datasync:LocationObjectStorage
properties:
    accessKey: string
    agentArns:
        - string
    bucketName: string
    secretKey: string
    serverCertificate: string
    serverHostname: string
    serverPort: 0
    serverProtocol: string
    subdirectory: string
    tags:
        string: string

    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:

    AgentArns List<string>
    A list of DataSync Agent ARNs with which this location will be associated.
    BucketName string
    The bucket on the self-managed object storage server that is used to read data from.
    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. An agent uses this host name to mount the object storage server in a network.
    AccessKey string
    The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    SecretKey string
    The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    ServerCertificate string
    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem string. The certificate can be up to 32768 bytes (before Base64 encoding).
    ServerPort int
    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
    ServerProtocol string
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    Subdirectory string
    A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.
    Tags Dictionary<string, string>
    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    AgentArns []string
    A list of DataSync Agent ARNs with which this location will be associated.
    BucketName string
    The bucket on the self-managed object storage server that is used to read data from.
    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. An agent uses this host name to mount the object storage server in a network.
    AccessKey string
    The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    SecretKey string
    The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    ServerCertificate string
    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem string. The certificate can be up to 32768 bytes (before Base64 encoding).
    ServerPort int
    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
    ServerProtocol string
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    Subdirectory string
    A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.
    Tags map[string]string
    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    agentArns List<String>
    A list of DataSync Agent ARNs with which this location will be associated.
    bucketName String
    The bucket on the self-managed object storage server that is used to read data from.
    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. An agent uses this host name to mount the object storage server in a network.
    accessKey String
    The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    secretKey String
    The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    serverCertificate String
    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem string. The certificate can be up to 32768 bytes (before Base64 encoding).
    serverPort Integer
    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
    serverProtocol String
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    subdirectory String
    A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.
    tags Map<String,String>
    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    agentArns string[]
    A list of DataSync Agent ARNs with which this location will be associated.
    bucketName string
    The bucket on the self-managed object storage server that is used to read data from.
    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. An agent uses this host name to mount the object storage server in a network.
    accessKey string
    The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    secretKey string
    The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    serverCertificate string
    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem string. The certificate can be up to 32768 bytes (before Base64 encoding).
    serverPort number
    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
    serverProtocol string
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    subdirectory string
    A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.
    tags {[key: string]: string}
    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    agent_arns Sequence[str]
    A list of DataSync Agent ARNs with which this location will be associated.
    bucket_name str
    The bucket on the self-managed object storage server that is used to read data from.
    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. An agent uses this host name to mount the object storage server in a network.
    access_key str
    The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    secret_key str
    The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    server_certificate str
    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem string. The certificate can be up to 32768 bytes (before Base64 encoding).
    server_port int
    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
    server_protocol str
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    subdirectory str
    A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.
    tags Mapping[str, str]
    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    agentArns List<String>
    A list of DataSync Agent ARNs with which this location will be associated.
    bucketName String
    The bucket on the self-managed object storage server that is used to read data from.
    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. An agent uses this host name to mount the object storage server in a network.
    accessKey String
    The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    secretKey String
    The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    serverCertificate String
    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem string. The certificate can be up to 32768 bytes (before Base64 encoding).
    serverPort Number
    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
    serverProtocol String
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    subdirectory String
    A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.
    tags Map<String>
    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LocationObjectStorage resource produces the following output properties:

    Arn string
    Amazon Resource Name (ARN) of the DataSync Location.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Uri string
    The URL of the Object Storage location that was described.
    Arn string
    Amazon Resource Name (ARN) of the DataSync Location.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Uri string
    The URL of the Object Storage location that was described.
    arn String
    Amazon Resource Name (ARN) of the DataSync Location.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    uri String
    The URL of the Object Storage location that was described.
    arn string
    Amazon Resource Name (ARN) of the DataSync Location.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    uri string
    The URL of the Object Storage location that was described.
    arn str
    Amazon Resource Name (ARN) of the DataSync Location.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    uri str
    The URL of the Object Storage location that was described.
    arn String
    Amazon Resource Name (ARN) of the DataSync Location.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    uri String
    The URL of the Object Storage location that was described.

    Look up Existing LocationObjectStorage Resource

    Get an existing LocationObjectStorage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: LocationObjectStorageState, opts?: CustomResourceOptions): LocationObjectStorage
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_key: Optional[str] = None,
        agent_arns: Optional[Sequence[str]] = None,
        arn: Optional[str] = None,
        bucket_name: Optional[str] = None,
        secret_key: Optional[str] = None,
        server_certificate: Optional[str] = None,
        server_hostname: Optional[str] = None,
        server_port: Optional[int] = None,
        server_protocol: Optional[str] = None,
        subdirectory: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        uri: Optional[str] = None) -> LocationObjectStorage
    func GetLocationObjectStorage(ctx *Context, name string, id IDInput, state *LocationObjectStorageState, opts ...ResourceOption) (*LocationObjectStorage, error)
    public static LocationObjectStorage Get(string name, Input<string> id, LocationObjectStorageState? state, CustomResourceOptions? opts = null)
    public static LocationObjectStorage get(String name, Output<String> id, LocationObjectStorageState state, CustomResourceOptions options)
    resources:  _:    type: aws:datasync:LocationObjectStorage    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccessKey string
    The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    AgentArns List<string>
    A list of DataSync Agent ARNs with which this location will be associated.
    Arn string
    Amazon Resource Name (ARN) of the DataSync Location.
    BucketName string
    The bucket on the self-managed object storage server that is used to read data from.
    SecretKey string
    The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    ServerCertificate string
    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem string. The certificate can be up to 32768 bytes (before Base64 encoding).
    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. An agent uses this host name to mount the object storage server in a network.
    ServerPort int
    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
    ServerProtocol string
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    Subdirectory string
    A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.
    Tags Dictionary<string, string>
    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Uri string
    The URL of the Object Storage location that was described.
    AccessKey string
    The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    AgentArns []string
    A list of DataSync Agent ARNs with which this location will be associated.
    Arn string
    Amazon Resource Name (ARN) of the DataSync Location.
    BucketName string
    The bucket on the self-managed object storage server that is used to read data from.
    SecretKey string
    The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    ServerCertificate string
    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem string. The certificate can be up to 32768 bytes (before Base64 encoding).
    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. An agent uses this host name to mount the object storage server in a network.
    ServerPort int
    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
    ServerProtocol string
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    Subdirectory string
    A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.
    Tags map[string]string
    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Uri string
    The URL of the Object Storage location that was described.
    accessKey String
    The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    agentArns List<String>
    A list of DataSync Agent ARNs with which this location will be associated.
    arn String
    Amazon Resource Name (ARN) of the DataSync Location.
    bucketName String
    The bucket on the self-managed object storage server that is used to read data from.
    secretKey String
    The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    serverCertificate String
    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem string. The certificate can be up to 32768 bytes (before Base64 encoding).
    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. An agent uses this host name to mount the object storage server in a network.
    serverPort Integer
    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
    serverProtocol String
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    subdirectory String
    A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.
    tags Map<String,String>
    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    uri String
    The URL of the Object Storage location that was described.
    accessKey string
    The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    agentArns string[]
    A list of DataSync Agent ARNs with which this location will be associated.
    arn string
    Amazon Resource Name (ARN) of the DataSync Location.
    bucketName string
    The bucket on the self-managed object storage server that is used to read data from.
    secretKey string
    The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    serverCertificate string
    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem string. The certificate can be up to 32768 bytes (before Base64 encoding).
    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. An agent uses this host name to mount the object storage server in a network.
    serverPort number
    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
    serverProtocol string
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    subdirectory string
    A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.
    tags {[key: string]: string}
    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    uri string
    The URL of the Object Storage location that was described.
    access_key str
    The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    agent_arns Sequence[str]
    A list of DataSync Agent ARNs with which this location will be associated.
    arn str
    Amazon Resource Name (ARN) of the DataSync Location.
    bucket_name str
    The bucket on the self-managed object storage server that is used to read data from.
    secret_key str
    The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    server_certificate str
    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem string. The certificate can be up to 32768 bytes (before Base64 encoding).
    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. An agent uses this host name to mount the object storage server in a network.
    server_port int
    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
    server_protocol str
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    subdirectory str
    A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.
    tags Mapping[str, str]
    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    uri str
    The URL of the Object Storage location that was described.
    accessKey String
    The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    agentArns List<String>
    A list of DataSync Agent ARNs with which this location will be associated.
    arn String
    Amazon Resource Name (ARN) of the DataSync Location.
    bucketName String
    The bucket on the self-managed object storage server that is used to read data from.
    secretKey String
    The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use access_key and secret_key to provide the user name and password, respectively.
    serverCertificate String
    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem string. The certificate can be up to 32768 bytes (before Base64 encoding).
    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. An agent uses this host name to mount the object storage server in a network.
    serverPort Number
    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
    serverProtocol String
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    subdirectory String
    A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.
    tags Map<String>
    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    uri String
    The URL of the Object Storage location that was described.

    Import

    Using pulumi import, import aws_datasync_location_object_storage using the Amazon Resource Name (ARN). For example:

    $ pulumi import aws:datasync/locationObjectStorage:LocationObjectStorage example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws