Package com.pulumi.aws.datasync
Class LocationObjectStorage
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.datasync.LocationObjectStorage
-
public class LocationObjectStorage extends com.pulumi.resources.CustomResourceManages a Object Storage Location within AWS DataSync. > **NOTE:** The DataSync Agents must be available before creating this resource. ## Example Usage
## Import ### Identity Schema #### Required - `arn` (String) ARN of the DataSync object storage location. Using `pulumi import`, import `aws.datasync.LocationObjectStorage` using the ARN. For example: ```sh $ pulumi import aws:datasync/locationObjectStorage:LocationObjectStorage example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ```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.ArrayList; import java.util.Arrays; 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()); } }
-
-
Constructor Summary
Constructors Constructor Description LocationObjectStorage(java.lang.String name)LocationObjectStorage(java.lang.String name, LocationObjectStorageArgs args)LocationObjectStorage(java.lang.String name, LocationObjectStorageArgs args, com.pulumi.resources.CustomResourceOptions options)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.pulumi.core.Output<java.util.Optional<java.lang.String>>accessKey()com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>>agentArns()com.pulumi.core.Output<java.lang.String>arn()com.pulumi.core.Output<java.lang.String>bucketName()static LocationObjectStorageget(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, LocationObjectStorageState state, com.pulumi.resources.CustomResourceOptions options)Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.lang.String>region()com.pulumi.core.Output<java.util.Optional<java.lang.String>>secretKey()com.pulumi.core.Output<java.util.Optional<java.lang.String>>serverCertificate()com.pulumi.core.Output<java.lang.String>serverHostname()com.pulumi.core.Output<java.util.Optional<java.lang.Integer>>serverPort()com.pulumi.core.Output<java.util.Optional<java.lang.String>>serverProtocol()com.pulumi.core.Output<java.lang.String>subdirectory()com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>tags()com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>tagsAll()com.pulumi.core.Output<java.lang.String>uri()
-
-
-
Constructor Detail
-
LocationObjectStorage
public LocationObjectStorage(java.lang.String name)
- Parameters:
name- The _unique_ name of the resulting resource.
-
LocationObjectStorage
public LocationObjectStorage(java.lang.String name, LocationObjectStorageArgs args)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.
-
LocationObjectStorage
public LocationObjectStorage(java.lang.String name, LocationObjectStorageArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.options- A bag of options that control this resource's behavior.
-
-
Method Detail
-
accessKey
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> accessKey()
- Returns:
- 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 `accessKey` and `secretKey` to provide the user name and password, respectively.
-
agentArns
public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> agentArns()
- Returns:
- A list of DataSync Agent ARNs with which this location will be associated. For agentless cross-cloud transfers, this parameter does not need to be specified.
-
arn
public com.pulumi.core.Output<java.lang.String> arn()
- Returns:
- ARN of the DataSync Location.
-
bucketName
public com.pulumi.core.Output<java.lang.String> bucketName()
- Returns:
- The bucket on the self-managed object storage server that is used to read data from.
-
region
public com.pulumi.core.Output<java.lang.String> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
secretKey
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> secretKey()
- Returns:
- 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 `accessKey` and `secretKey` to provide the user name and password, respectively.
-
serverCertificate
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> serverCertificate()
- Returns:
- 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
public com.pulumi.core.Output<java.lang.String> serverHostname()
- Returns:
- 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
public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> serverPort()
- Returns:
- 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
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> serverProtocol()
- Returns:
- The protocol that the object storage server uses to communicate. Valid values are `HTTP` or `HTTPS`.
-
subdirectory
public com.pulumi.core.Output<java.lang.String> subdirectory()
- Returns:
- 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
public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
-
tagsAll
public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()
- Returns:
- A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
-
uri
public com.pulumi.core.Output<java.lang.String> uri()
- Returns:
- The URL of the Object Storage location that was described.
-
get
public static LocationObjectStorage get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable LocationObjectStorageState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name- The _unique_ name of the resulting resource.id- The _unique_ provider ID of the resource to lookup.state-options- Optional settings to control the behavior of the CustomResource.
-
-