Package com.pulumi.aws.quicksight

Class DataSource

  • public class DataSource
extends com.pulumi.resources.CustomResource
    Resource for managing QuickSight Data Source ## Example Usage ### S3 Data Source 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.quicksight.DataSource;
 import com.pulumi.aws.quicksight.DataSourceArgs;
 import com.pulumi.aws.quicksight.inputs.DataSourceParametersArgs;
 import com.pulumi.aws.quicksight.inputs.DataSourceParametersS3Args;
 import com.pulumi.aws.quicksight.inputs.DataSourceParametersS3ManifestFileLocationArgs;
 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 default_ = new DataSource("default", DataSourceArgs.builder()
             .parameters(DataSourceParametersArgs.builder()
                 .s3(DataSourceParametersS3Args.builder()
                     .manifestFileLocation(DataSourceParametersS3ManifestFileLocationArgs.builder()
                         .bucket("my-bucket")
                         .key("path/to/manifest.json")
                         .build())
                     .build())
                 .build())
             .dataSourceId("example-id")
             .name("My Cool Data in S3")
             .type("S3")
             .build());
 
     }
 }
    ### S3 Data Source with IAM Role ARN 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.AwsFunctions;
 import com.pulumi.aws.inputs.GetCallerIdentityArgs;
 import com.pulumi.aws.inputs.GetPartitionArgs;
 import com.pulumi.aws.inputs.GetRegionArgs;
 import com.pulumi.aws.s3.Bucket;
 import com.pulumi.aws.s3.BucketObjectv2;
 import com.pulumi.aws.s3.BucketObjectv2Args;
 import com.pulumi.aws.iam.Role;
 import com.pulumi.aws.iam.RoleArgs;
 import com.pulumi.aws.iam.Policy;
 import com.pulumi.aws.iam.PolicyArgs;
 import com.pulumi.aws.iam.RolePolicyAttachment;
 import com.pulumi.aws.iam.RolePolicyAttachmentArgs;
 import com.pulumi.aws.quicksight.DataSource;
 import com.pulumi.aws.quicksight.DataSourceArgs;
 import com.pulumi.aws.quicksight.inputs.DataSourceParametersArgs;
 import com.pulumi.aws.quicksight.inputs.DataSourceParametersS3Args;
 import com.pulumi.aws.quicksight.inputs.DataSourceParametersS3ManifestFileLocationArgs;
 import static com.pulumi.codegen.internal.Serialization.*;
 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) {
         final var current = AwsFunctions.getCallerIdentity(GetCallerIdentityArgs.builder()
             .build());
 
         final var currentGetPartition = AwsFunctions.getPartition(GetPartitionArgs.builder()
             .build());
 
         final var currentGetRegion = AwsFunctions.getRegion(GetRegionArgs.builder()
             .build());
 
         var example = new Bucket("example");
 
         var exampleBucketObjectv2 = new BucketObjectv2("exampleBucketObjectv2", BucketObjectv2Args.builder()
             .bucket(example.bucket())
             .key("manifest.json")
             .content(example.id().applyValue(_id -> serializeJson(
                 jsonObject(
                     jsonProperty("fileLocations", jsonArray(jsonObject(
                         jsonProperty("URIPrefixes", jsonArray(String.format("https://%s.s3-%s.%s", _id,currentGetRegion.region(),currentGetPartition.dnsSuffix())))
                     ))),
                     jsonProperty("globalUploadSettings", jsonObject(
                         jsonProperty("format", "CSV"),
                         jsonProperty("delimiter", ","),
                         jsonProperty("textqualifier", "\""),
                         jsonProperty("containsHeader", true)
                     ))
                 ))))
             .build());
 
         var exampleRole = new Role("exampleRole", RoleArgs.builder()
             .name("example")
             .assumeRolePolicy(serializeJson(
                 jsonObject(
                     jsonProperty("Version", "2012-10-17"),
                     jsonProperty("Statement", jsonArray(jsonObject(
                         jsonProperty("Action", "sts:AssumeRole"),
                         jsonProperty("Effect", "Allow"),
                         jsonProperty("Principal", jsonObject(
                             jsonProperty("Service", "quicksight.amazonaws.com")
                         )),
                         jsonProperty("Condition", jsonObject(
                             jsonProperty("StringEquals", jsonObject(
                                 jsonProperty("aws:SourceAccount", current.accountId())
                             ))
                         ))
                     )))
                 )))
             .build());
 
         var examplePolicy = new Policy("examplePolicy", PolicyArgs.builder()
             .name("example")
             .description("Policy to allow QuickSight access to S3 bucket")
             .policy(Output.tuple(example.arn(), exampleBucketObjectv2.key()).applyValue(values -> {
                 var arn = values.t1;
                 var key = values.t2;
                 return serializeJson(
                     jsonObject(
                         jsonProperty("Version", "2012-10-17"),
                         jsonProperty("Statement", jsonArray(
                             jsonObject(
                                 jsonProperty("Action", jsonArray("s3:GetObject")),
                                 jsonProperty("Effect", "Allow"),
                                 jsonProperty("Resource", String.format("%s/%s", arn,key))
                             ), 
                             jsonObject(
                                 jsonProperty("Action", jsonArray("s3:ListBucket")),
                                 jsonProperty("Effect", "Allow"),
                                 jsonProperty("Resource", arn)
                             )
                         ))
                     ));
             }))
             .build());
 
         var exampleRolePolicyAttachment = new RolePolicyAttachment("exampleRolePolicyAttachment", RolePolicyAttachmentArgs.builder()
             .policyArn(examplePolicy.arn())
             .role(exampleRole.name())
             .build());
 
         var exampleDataSource = new DataSource("exampleDataSource", DataSourceArgs.builder()
             .parameters(DataSourceParametersArgs.builder()
                 .s3(DataSourceParametersS3Args.builder()
                     .manifestFileLocation(DataSourceParametersS3ManifestFileLocationArgs.builder()
                         .bucket(example.bucket())
                         .key(exampleBucketObjectv2.key())
                         .build())
                     .roleArn(exampleRole.arn())
                     .build())
                 .build())
             .dataSourceId("example-id")
             .name("manifest in S3")
             .type("S3")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import a QuickSight data source using the AWS account ID, and data source ID separated by a slash (`/`). For example: ```sh $ pulumi import aws:quicksight/dataSource:DataSource example 123456789123/my-data-source-id ```

    • 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> awsAccountId()  
      com.pulumi.core.Output<java.util.Optional<DataSourceCredentials>> credentials()  
      com.pulumi.core.Output<java.lang.String> dataSourceId()  
      static DataSource get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DataSourceState 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> name()  
      com.pulumi.core.Output<DataSourceParameters> parameters()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<DataSourcePermission>>> permissions()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<DataSourceSslProperties> sslProperties()  
      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> type()  
      com.pulumi.core.Output<java.util.Optional<DataSourceVpcConnectionProperties>> vpcConnectionProperties()  

      • 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

      • DataSource

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

      • DataSource

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

      • DataSource

        public DataSource​(java.lang.String name,
                  DataSourceArgs 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 data source

      • awsAccountId

        public com.pulumi.core.Output<java.lang.String> awsAccountId()
        Returns:
        AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.

      • credentials

        public com.pulumi.core.Output<java.util.Optional<DataSourceCredentials>> credentials()
        Returns:
        Credentials Amazon QuickSight uses to connect to your underlying source. See `credentials` Block below for more details.

      • dataSourceId

        public com.pulumi.core.Output<java.lang.String> dataSourceId()
        Returns:
        Identifier for the data source.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name for the data source, maximum of 128 characters.

      • parameters

        public com.pulumi.core.Output<DataSourceParameters> parameters()
        Returns:
        Parameters used to connect to this data source (exactly one). See `parameters` Block for details.

      • permissions

        public com.pulumi.core.Output<java.util.Optional<java.util.List<DataSourcePermission>>> permissions()
        Returns:
        Set of resource permissions on the data source. Maximum of 64 items. See `permission` Block below for more details.

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

      • sslProperties

        public com.pulumi.core.Output<DataSourceSslProperties> sslProperties()
        Returns:
        Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. See `sslProperties` Block below for more details.

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

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        Type of the data source. See the [AWS Documentation](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateDataSource.html#QS-CreateDataSource-request-Type) for the complete list of valid values. The following arguments are optional:

      • vpcConnectionProperties

        public com.pulumi.core.Output<java.util.Optional<DataSourceVpcConnectionProperties>> vpcConnectionProperties()
        Returns:
        Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. See `vpcConnectionProperties` Block below for more details.

      • get

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