pulumi-aws-kotlin/com.pulumi.aws.datasync.kotlin/LocationObjectStorage

LocationObjectStorage

class LocationObjectStorage : KotlinCustomResource

Manages a Object Storage Location within AWS DataSync.

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

Example Usage

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(aws_datasync_agent.example().arn())
            .serverHostname("example")
            .bucketName("example")
            .build());
    }
}

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

Properties

accessKey

val accessKey: Output<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

val agentArns: Output<List<String>>

A list of DataSync Agent ARNs with which this location will be associated.

arn

val arn: Output<String>

Amazon Resource Name (ARN) of the DataSync Location.

bucketName

val bucketName: Output<String>

The bucket on the self-managed object storage server that is used to read data from.

val id: Output<String>

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

secretKey

val secretKey: Output<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

val serverCertificate: Output<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

val serverHostname: Output<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

val serverPort: Output<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

val serverProtocol: Output<String>?

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

subdirectory

val subdirectory: Output<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 /.