Package com.pulumi.aws.datasync

Class LocationObjectStorage

  • public class LocationObjectStorage
extends com.pulumi.resources.CustomResource
    Manages a Object Storage Location within AWS DataSync. > **NOTE:** The DataSync Agents must be available before creating this resource. ## Example Usage <!--Start PulumiCodeChooser --> ```java 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()); } } ``` <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import `aws_datasync_location_object_storage` using the Amazon Resource Name (ARN). For example: ```sh $ pulumi import aws:datasync/locationObjectStorage:LocationObjectStorage example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • 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.List<java.lang.String>> agentArns()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> bucketName()  
      static LocationObjectStorage get​(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.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()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • 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 `access_key` and `secret_key` to provide the user name and password, respectively.

      • agentArns

        public com.pulumi.core.Output<java.util.List<java.lang.String>> agentArns()
        Returns:
        A list of DataSync Agent ARNs with which this location will be associated.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        Amazon Resource Name (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.

      • 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 `access_key` and `secret_key` 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 `default_tags` 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 `default_tags` 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.