Package com.pulumi.aws.glue

Class CatalogDatabase

  • public class CatalogDatabase
extends com.pulumi.resources.CustomResource
    Provides a Glue Catalog Database Resource. You can refer to the [Glue Developer Guide](http://docs.aws.amazon.com/glue/latest/dg/populate-data-catalog.html) for a full explanation of the Glue Data Catalog functionality ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.glue.CatalogDatabase;
 import com.pulumi.aws.glue.CatalogDatabaseArgs;
 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 CatalogDatabase("example", CatalogDatabaseArgs.builder()
             .name("MyCatalogDatabase")
             .build());
 
     }
 }
    ### Create Table Default Permissions 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.glue.CatalogDatabase;
 import com.pulumi.aws.glue.CatalogDatabaseArgs;
 import com.pulumi.aws.glue.inputs.CatalogDatabaseCreateTableDefaultPermissionArgs;
 import com.pulumi.aws.glue.inputs.CatalogDatabaseCreateTableDefaultPermissionPrincipalArgs;
 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 CatalogDatabase("example", CatalogDatabaseArgs.builder()
             .createTableDefaultPermissions(CatalogDatabaseCreateTableDefaultPermissionArgs.builder()
                 .principal(CatalogDatabaseCreateTableDefaultPermissionPrincipalArgs.builder()
                     .dataLakePrincipalIdentifier("IAM_ALLOWED_PRINCIPALS")
                     .build())
                 .permissions("SELECT")
                 .build())
             .name("MyCatalogDatabase")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Glue Catalog Databases using the `catalog_id:name`. If you have not set a Catalog ID specify the AWS Account ID that the database is in. For example: ```sh $ pulumi import aws:glue/catalogDatabase:CatalogDatabase database 123456789012:my_database ```

    • 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.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> catalogId()  
      com.pulumi.core.Output<java.util.List<CatalogDatabaseCreateTableDefaultPermission>> createTableDefaultPermissions()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.util.Optional<CatalogDatabaseFederatedDatabase>> federatedDatabase()  
      static CatalogDatabase get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, CatalogDatabaseState 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> locationUri()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> parameters()  
      com.pulumi.core.Output<java.lang.String> region()  
      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.util.Optional<CatalogDatabaseTargetDatabase>> targetDatabase()  

      • 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

      • CatalogDatabase

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

      • CatalogDatabase

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

      • CatalogDatabase

        public CatalogDatabase​(java.lang.String name,
                       @Nullable
                       CatalogDatabaseArgs 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

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the Glue Catalog Database.

      • catalogId

        public com.pulumi.core.Output<java.lang.String> catalogId()
        Returns:
        ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.

      • createTableDefaultPermissions

        public com.pulumi.core.Output<java.util.List<CatalogDatabaseCreateTableDefaultPermission>> createTableDefaultPermissions()
        Returns:
        Creates a set of default permissions on the table for principals. See `createTableDefaultPermission` Block below.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the database.

      • federatedDatabase

        public com.pulumi.core.Output<java.util.Optional<CatalogDatabaseFederatedDatabase>> federatedDatabase()
        Returns:
        Configuration block that references an entity outside the AWS Glue Data Catalog. See `federatedDatabase` Block below.

      • locationUri

        public com.pulumi.core.Output<java.lang.String> locationUri()
        Returns:
        Location of the database (for example, an HDFS path).

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the database. The acceptable characters are lowercase letters, numbers, and the underscore character.

      • parameters

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> parameters()
        Returns:
        List of key-value pairs that define parameters and properties of the database.

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

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. 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:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • targetDatabase

        public com.pulumi.core.Output<java.util.Optional<CatalogDatabaseTargetDatabase>> targetDatabase()
        Returns:
        Configuration block for a target database for resource linking. See `targetDatabase` Block below.

      • get

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