AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

LocationObjectStorage

Resource schema for AWS::DataSync::LocationObjectStorage.

Example Usage

Example

using Pulumi;
using AwsNative = Pulumi.AwsNative;

class MyStack : Stack
{
    public MyStack()
    {
        var locationObjectStorage = new AwsNative.DataSync.LocationObjectStorage("locationObjectStorage", new AwsNative.DataSync.LocationObjectStorageArgs
        {
            AgentArns = 
            {
                "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
	})
}

Coming soon!

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")
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",
});

Coming soon!

Example

using Pulumi;
using AwsNative = Pulumi.AwsNative;

class MyStack : Stack
{
    public MyStack()
    {
        var locationObjectStorage = new AwsNative.DataSync.LocationObjectStorage("locationObjectStorage", new AwsNative.DataSync.LocationObjectStorageArgs
        {
            AgentArns = 
            {
                "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
	})
}

Coming soon!

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")
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",
});

Coming soon!

Create a LocationObjectStorage Resource

new LocationObjectStorage(name: string, args: LocationObjectStorageArgs, opts?: CustomResourceOptions);
@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,
                          secret_key: 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[LocationObjectStorageTagArgs]] = None)
@overload
def LocationObjectStorage(resource_name: str,
                          args: LocationObjectStorageArgs,
                          opts: Optional[ResourceOptions] = 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-native:datasync:LocationObjectStorage
properties: # The arguments to resource properties.
options: # 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.
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

The LocationObjectStorage resource accepts the following input properties:

AgentArns List<string>

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

BucketName string

The name of the bucket on the self-managed object storage server.

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.

AccessKey string

Optional. The access key is used if credentials are required to access the self-managed object storage server.

SecretKey string

Optional. The secret key is used if credentials are required to access the self-managed object storage server.

ServerPort int

The port that your self-managed server accepts inbound network traffic on.

ServerProtocol Pulumi.AwsNative.DataSync.LocationObjectStorageServerProtocol

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.

Tags List<Pulumi.AwsNative.DataSync.Inputs.LocationObjectStorageTagArgs>

An array of key-value pairs to apply to this resource.

AgentArns []string

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

BucketName string

The name of the bucket on the self-managed object storage server.

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.

AccessKey string

Optional. The access key is used if credentials are required to access the self-managed object storage server.

SecretKey string

Optional. The secret key is used if credentials are required to access the self-managed object storage server.

ServerPort int

The port that your self-managed server accepts inbound network traffic on.

ServerProtocol LocationObjectStorageServerProtocol

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.

Tags []LocationObjectStorageTagArgs

An array of key-value pairs to apply to this resource.

agentArns List<String>

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

bucketName String

The name of the bucket on the self-managed object storage server.

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.

accessKey String

Optional. The access key is used if credentials are required to access the self-managed object storage server.

secretKey String

Optional. The secret key is used if credentials are required to access the self-managed object storage server.

serverPort Integer

The port that your self-managed server accepts inbound network traffic on.

serverProtocol LocationObjectStorageServerProtocol

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.

tags List<LocationObjectStorageTagArgs>

An array of key-value pairs to apply to this resource.

agentArns string[]

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

bucketName string

The name of the bucket on the self-managed object storage server.

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.

accessKey string

Optional. The access key is used if credentials are required to access the self-managed object storage server.

secretKey string

Optional. The secret key is used if credentials are required to access the self-managed object storage server.

serverPort number

The port that your self-managed server accepts inbound network traffic on.

serverProtocol LocationObjectStorageServerProtocol

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.

tags LocationObjectStorageTagArgs[]

An array of key-value pairs to apply to this resource.

agent_arns Sequence[str]

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

bucket_name str

The name of the bucket on the self-managed object storage server.

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.

access_key str

Optional. The access key is used if credentials are required to access the self-managed object storage server.

secret_key str

Optional. The secret key is used if credentials are required to access the self-managed object storage server.

server_port int

The port that your self-managed server accepts inbound network traffic on.

server_protocol LocationObjectStorageServerProtocol

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.

tags Sequence[LocationObjectStorageTagArgs]

An array of key-value pairs to apply to this resource.

agentArns List<String>

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

bucketName String

The name of the bucket on the self-managed object storage server.

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.

accessKey String

Optional. The access key is used if credentials are required to access the self-managed object storage server.

secretKey String

Optional. The secret key is used if credentials are required to access the self-managed 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.

tags 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.

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.

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.

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.

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.

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.

Supporting Types

LocationObjectStorageServerProtocol

Https
HTTPS
Http
HTTP
LocationObjectStorageServerProtocolHttps
HTTPS
LocationObjectStorageServerProtocolHttp
HTTP
Https
HTTPS
Http
HTTP
Https
HTTPS
Http
HTTP
HTTPS
HTTPS
HTTP
HTTP
"HTTPS"
HTTPS
"HTTP"
HTTP

LocationObjectStorageTag

Key string

The key for an AWS resource tag.

Value string

The value for an AWS resource tag.

Key string

The key for an AWS resource tag.

Value string

The value for an AWS resource tag.

key String

The key for an AWS resource tag.

value String

The value for an AWS resource tag.

key string

The key for an AWS resource tag.

value string

The value for an AWS resource tag.

key str

The key for an AWS resource tag.

value str

The value for an AWS resource tag.

key String

The key for an AWS resource tag.

value String

The value for an AWS resource tag.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0