Package com.pulumi.aws.redshift

Class Integration

  • public class Integration
extends com.pulumi.resources.CustomResource
    Resource for managing a DynamoDB zero-ETL integration or S3 event integration with Amazon Redshift. You can refer to the [User Guide](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/RedshiftforDynamoDB-zero-etl.html) for a DynamoDB zero-ETL integration or the [User Guide](https://docs.aws.amazon.com/redshift/latest/dg/loading-data-copy-job.html) for a S3 event integration. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.dynamodb.Table;
 import com.pulumi.aws.dynamodb.TableArgs;
 import com.pulumi.aws.dynamodb.inputs.TablePointInTimeRecoveryArgs;
 import com.pulumi.aws.dynamodb.inputs.TableAttributeArgs;
 import com.pulumi.aws.redshiftserverless.Namespace;
 import com.pulumi.aws.redshiftserverless.NamespaceArgs;
 import com.pulumi.aws.redshiftserverless.Workgroup;
 import com.pulumi.aws.redshiftserverless.WorkgroupArgs;
 import com.pulumi.aws.redshiftserverless.inputs.WorkgroupConfigParameterArgs;
 import com.pulumi.aws.redshift.Integration;
 import com.pulumi.aws.redshift.IntegrationArgs;
 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 Table("example", TableArgs.builder()
             .pointInTimeRecovery(TablePointInTimeRecoveryArgs.builder()
                 .enabled(true)
                 .build())
             .attributes(TableAttributeArgs.builder()
                 .name("example")
                 .type("S")
                 .build())
             .name("dynamodb-table-example")
             .readCapacity(1)
             .writeCapacity(1)
             .hashKey("example")
             .build());
 
         var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()
             .namespaceName("redshift-example")
             .build());
 
         var exampleWorkgroup = new Workgroup("exampleWorkgroup", WorkgroupArgs.builder()
             .configParameters(WorkgroupConfigParameterArgs.builder()
                 .parameterKey("enable_case_sensitive_identifier")
                 .parameterValue("true")
                 .build())
             .namespaceName(exampleNamespace.namespaceName())
             .workgroupName("example-workgroup")
             .baseCapacity(8)
             .publiclyAccessible(false)
             .subnetIds(            
                 example1.id(),
                 example2.id(),
                 example3.id())
             .build());
 
         var exampleIntegration = new Integration("exampleIntegration", IntegrationArgs.builder()
             .integrationName("example")
             .sourceArn(example.arn())
             .targetArn(exampleNamespace.arn())
             .build());
 
     }
 }
    ### Use own KMS key 
     
 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.kms.Key;
 import com.pulumi.aws.kms.KeyArgs;
 import com.pulumi.aws.kms.KeyPolicy;
 import com.pulumi.aws.kms.KeyPolicyArgs;
 import com.pulumi.aws.redshift.Integration;
 import com.pulumi.aws.redshift.IntegrationArgs;
 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());
 
         var example = new Key("example", KeyArgs.builder()
             .description("example")
             .deletionWindowInDays(10)
             .build());
 
         var exampleKeyPolicy = new KeyPolicy("exampleKeyPolicy", KeyPolicyArgs.builder()
             .keyId(example.id())
             .policy(serializeJson(
                 jsonObject(
                     jsonProperty("Version", "2008-10-17"),
                     jsonProperty("Statement", jsonArray(
                         jsonObject(
                             jsonProperty("Effect", "Allow"),
                             jsonProperty("Principal", jsonObject(
                                 jsonProperty("AWS", String.format("arn:aws:iam::%s:root", current.accountId()))
                             )),
                             jsonProperty("Action", "kms:*"),
                             jsonProperty("Resource", "*")
                         ), 
                         jsonObject(
                             jsonProperty("Effect", "Allow"),
                             jsonProperty("Principal", jsonObject(
                                 jsonProperty("Service", "redshift.amazonaws.com")
                             )),
                             jsonProperty("Action", jsonArray(
                                 "kms:Decrypt", 
                                 "kms:CreateGrant"
                             )),
                             jsonProperty("Resource", "*"),
                             jsonProperty("Condition", jsonObject(
                                 jsonProperty("StringEquals", jsonObject(
                                     jsonProperty("aws:SourceAccount", current.accountId())
                                 )),
                                 jsonProperty("ArnEquals", jsonObject(
                                     jsonProperty("aws:SourceArn", String.format("arn:aws:redshift:*:%s:integration:*", current.accountId()))
                                 ))
                             ))
                         )
                     ))
                 )))
             .build());
 
         var exampleIntegration = new Integration("exampleIntegration", IntegrationArgs.builder()
             .integrationName("example")
             .sourceArn(exampleAwsDynamodbTable.arn())
             .targetArn(exampleAwsRedshiftserverlessNamespace.arn())
             .kmsKeyId(example.arn())
             .additionalEncryptionContext(Map.of("example", "test"))
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required - `arn` (String) ARN of the Redshift integration. Using `pulumi import`, import Redshift Integration using the `arn`. For example: ```sh $ pulumi import aws:redshift/integration:Integration example arn:aws:redshift:us-west-2:123456789012:integration:abcdefgh-0000-1111-2222-123456789012 ```

    • 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.util.Map<java.lang.String,​java.lang.String>>> additionalEncryptionContext()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static Integration get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, IntegrationState 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> integrationName()  
      com.pulumi.core.Output<java.lang.String> kmsKeyId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> sourceArn()  
      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> targetArn()  
      com.pulumi.core.Output<java.util.Optional<IntegrationTimeouts>> timeouts()  

      • 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

      • Integration

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

      • Integration

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

      • Integration

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

      • additionalEncryptionContext

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> additionalEncryptionContext()
        Returns:
        Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the [User Guide](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context). You can only include this parameter if you specify the `kmsKeyId` parameter.

      • arn

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

      • description

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

      • integrationName

        public com.pulumi.core.Output<java.lang.String> integrationName()
        Returns:
        Name of the integration.

      • kmsKeyId

        public com.pulumi.core.Output<java.lang.String> kmsKeyId()
        Returns:
        KMS key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, Redshift uses a default AWS owned key. You can only include this parameter if `sourceArn` references a DynamoDB table.

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

      • sourceArn

        public com.pulumi.core.Output<java.lang.String> sourceArn()
        Returns:
        ARN of the database to use as the source for replication. You can specify a DynamoDB table or an S3 bucket.

      • 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. For more detailed documentation about each argument, refer to the [AWS official documentation](https://docs.aws.amazon.com/cli/latest/reference/redshift/create-integration.html).

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

      • targetArn

        public com.pulumi.core.Output<java.lang.String> targetArn()
        Returns:
        ARN of the Redshift data warehouse to use as the target for replication. The following arguments are optional:

      • get

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