Package com.pulumi.aws.datasync

Class LocationHdfs

  • public class LocationHdfs
extends com.pulumi.resources.CustomResource
    Manages an HDFS 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.LocationHdfs; import com.pulumi.aws.datasync.LocationHdfsArgs; import com.pulumi.aws.datasync.inputs.LocationHdfsNameNodeArgs; 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 LocationHdfs("example", LocationHdfsArgs.builder() .agentArns(exampleAwsDatasyncAgent.arn()) .authenticationType("SIMPLE") .simpleUser("example") .nameNodes(LocationHdfsNameNodeArgs.builder() .hostname(exampleAwsInstance.privateDns()) .port(80) .build()) .build()); } } ``` <!--End PulumiCodeChooser --> ### Kerberos Authentication <!--Start PulumiCodeChooser --> ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.datasync.LocationHdfs; import com.pulumi.aws.datasync.LocationHdfsArgs; import com.pulumi.aws.datasync.inputs.LocationHdfsNameNodeArgs; 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 LocationHdfs("example", LocationHdfsArgs.builder() .agentArns(exampleAwsDatasyncAgent.arn()) .authenticationType("KERBEROS") .nameNodes(LocationHdfsNameNodeArgs.builder() .hostname(exampleAwsInstance.privateDns()) .port(80) .build()) .kerberosPrincipal("[email protected]") .kerberosKeytabBase64(StdFunctions.filebase64(Filebase64Args.builder() .input("user.keytab") .build()).result()) .kerberosKrb5Conf(StdFunctions.file(FileArgs.builder() .input("krb5.conf") .build()).result()) .build()); } } ``` <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import `aws_datasync_location_hdfs` using the Amazon Resource Name (ARN). For example: ```sh $ pulumi import aws:datasync/locationHdfs:LocationHdfs 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.List<java.lang.String>> agentArns()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> authenticationType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> blockSize()  
      static LocationHdfs get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, LocationHdfsState 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>> kerberosKeytab()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kerberosKeytabBase64()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kerberosKrb5Conf()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kerberosKrb5ConfBase64()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kerberosPrincipal()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyProviderUri()  
      com.pulumi.core.Output<java.util.List<LocationHdfsNameNode>> nameNodes()  
      com.pulumi.core.Output<LocationHdfsQopConfiguration> qopConfiguration()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> replicationFactor()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> simpleUser()  
      com.pulumi.core.Output<java.util.Optional<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

      • LocationHdfs

        public LocationHdfs​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • LocationHdfs

        public LocationHdfs​(java.lang.String name,
                    LocationHdfsArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • LocationHdfs

        public LocationHdfs​(java.lang.String name,
                    LocationHdfsArgs 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

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

      • authenticationType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> authenticationType()
        Returns:
        The type of authentication used to determine the identity of the user. Valid values are `SIMPLE` and `KERBEROS`.

      • blockSize

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> blockSize()
        Returns:
        The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB).

      • kerberosKeytab

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kerberosKeytab()
        Returns:
        The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. Use `kerberos_keytab_base64` instead whenever the value is not a valid UTF-8 string. If `KERBEROS` is specified for `authentication_type`, this parameter (or `kerberos_keytab_base64`) is required.

      • kerberosKeytabBase64

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kerberosKeytabBase64()
        Returns:
        Use instead of `kerberos_keytab` to pass base64-encoded binary data directly. If `KERBEROS` is specified for `authentication_type`, this parameter (or `kerberos_keytab`) is required.

      • kerberosKrb5Conf

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kerberosKrb5Conf()
        Returns:
        The krb5.conf file that contains the Kerberos configuration information. Use `kerberos_krb5_conf_base64` instead whenever the value is not a valid UTF-8 string. If `KERBEROS` is specified for `authentication_type`, this parameter (or `kerberos_krb5_conf_base64`) is required.

      • kerberosKrb5ConfBase64

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kerberosKrb5ConfBase64()
        Returns:
        Use instead of `kerberos_krb5_conf` to pass base64-encoded binary data directly. If `KERBEROS` is specified for `authentication_type`, this parameter (or `kerberos_krb5_conf`) is required.

      • kerberosPrincipal

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kerberosPrincipal()
        Returns:
        The Kerberos principal with access to the files and folders on the HDFS cluster. If `KERBEROS` is specified for `authentication_type`, this parameter is required.

      • kmsKeyProviderUri

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyProviderUri()
        Returns:
        The URI of the HDFS cluster's Key Management Server (KMS).

      • nameNodes

        public com.pulumi.core.Output<java.util.List<LocationHdfsNameNode>> nameNodes()
        Returns:
        The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode. See configuration below.

      • qopConfiguration

        public com.pulumi.core.Output<LocationHdfsQopConfiguration> qopConfiguration()
        Returns:
        The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the Hadoop Distributed File System (HDFS) cluster. If `qop_configuration` isn't specified, `rpc_protection` and `data_transfer_protection` default to `PRIVACY`. If you set RpcProtection or DataTransferProtection, the other parameter assumes the same value. See configuration below.

      • replicationFactor

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> replicationFactor()
        Returns:
        The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.

      • simpleUser

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> simpleUser()
        Returns:
        The user name used to identify the client on the host operating system. If `SIMPLE` is specified for `authentication_type`, this parameter is required.

      • subdirectory

        public com.pulumi.core.Output<java.util.Optional<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()

      • get

        public static LocationHdfs get​(java.lang.String name,
                               com.pulumi.core.Output<java.lang.String> id,
                               @Nullable
                               LocationHdfsState 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.