Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rds
  5. Integration

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.Integration

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    A zero-ETL integration with Amazon Redshift.

    Create Integration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Integration(name: string, args: IntegrationArgs, opts?: CustomResourceOptions);
    @overload
def Integration(resource_name: str,
                args: IntegrationArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Integration(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                source_arn: Optional[str] = None,
                target_arn: Optional[str] = None,
                additional_encryption_context: Optional[Mapping[str, str]] = None,
                data_filter: Optional[str] = None,
                description: Optional[str] = None,
                integration_name: Optional[str] = None,
                kms_key_id: Optional[str] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewIntegration(ctx *Context, name string, args IntegrationArgs, opts ...ResourceOption) (*Integration, error)
    public Integration(string name, IntegrationArgs args, CustomResourceOptions? opts = null)
    public Integration(String name, IntegrationArgs args)
public Integration(String name, IntegrationArgs args, CustomResourceOptions options)

    type: aws-native:rds:Integration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Integration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Integration resource accepts the following input properties:

    SourceArn string
    The Amazon Resource Name (ARN) of the database to use as the source for replication.
    TargetArn string
    The ARN of the Redshift data warehouse to use as the target for replication.
    AdditionalEncryptionContext Dictionary<string, string>
    An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Key Management Service Developer Guide. You can only include this parameter if you specify the KMSKeyId parameter.
    DataFilter string
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
    Description string
    A description of the integration.
    IntegrationName string
    The name of the integration.
    KmsKeyId string
    The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide..
    SourceArn string
    The Amazon Resource Name (ARN) of the database to use as the source for replication.
    TargetArn string
    The ARN of the Redshift data warehouse to use as the target for replication.
    AdditionalEncryptionContext map[string]string
    An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Key Management Service Developer Guide. You can only include this parameter if you specify the KMSKeyId parameter.
    DataFilter string
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
    Description string
    A description of the integration.
    IntegrationName string
    The name of the integration.
    KmsKeyId string
    The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key.
    Tags TagArgs
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide..
    sourceArn String
    The Amazon Resource Name (ARN) of the database to use as the source for replication.
    targetArn String
    The ARN of the Redshift data warehouse to use as the target for replication.
    additionalEncryptionContext Map<String,String>
    An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Key Management Service Developer Guide. You can only include this parameter if you specify the KMSKeyId parameter.
    dataFilter String
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
    description String
    A description of the integration.
    integrationName String
    The name of the integration.
    kmsKeyId String
    The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key.
    tags List<Tag>
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide..
    sourceArn string
    The Amazon Resource Name (ARN) of the database to use as the source for replication.
    targetArn string
    The ARN of the Redshift data warehouse to use as the target for replication.
    additionalEncryptionContext {[key: string]: string}
    An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Key Management Service Developer Guide. You can only include this parameter if you specify the KMSKeyId parameter.
    dataFilter string
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
    description string
    A description of the integration.
    integrationName string
    The name of the integration.
    kmsKeyId string
    The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key.
    tags Tag[]
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide..
    source_arn str
    The Amazon Resource Name (ARN) of the database to use as the source for replication.
    target_arn str
    The ARN of the Redshift data warehouse to use as the target for replication.
    additional_encryption_context Mapping[str, str]
    An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Key Management Service Developer Guide. You can only include this parameter if you specify the KMSKeyId parameter.
    data_filter str
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
    description str
    A description of the integration.
    integration_name str
    The name of the integration.
    kms_key_id str
    The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key.
    tags Sequence[TagArgs]
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide..
    sourceArn String
    The Amazon Resource Name (ARN) of the database to use as the source for replication.
    targetArn String
    The ARN of the Redshift data warehouse to use as the target for replication.
    additionalEncryptionContext Map<String>
    An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Key Management Service Developer Guide. You can only include this parameter if you specify the KMSKeyId parameter.
    dataFilter String
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
    description String
    A description of the integration.
    integrationName String
    The name of the integration.
    kmsKeyId String
    The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key.
    tags List<Property Map>
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide..

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Integration resource produces the following output properties:

    CreateTime string
    The time when the integration was created, in Universal Coordinated Time (UTC).
    Id string
    The provider-assigned unique ID for this managed resource.
    IntegrationArn string
    The ARN of the integration.
    CreateTime string
    The time when the integration was created, in Universal Coordinated Time (UTC).
    Id string
    The provider-assigned unique ID for this managed resource.
    IntegrationArn string
    The ARN of the integration.
    createTime String
    The time when the integration was created, in Universal Coordinated Time (UTC).
    id String
    The provider-assigned unique ID for this managed resource.
    integrationArn String
    The ARN of the integration.
    createTime string
    The time when the integration was created, in Universal Coordinated Time (UTC).
    id string
    The provider-assigned unique ID for this managed resource.
    integrationArn string
    The ARN of the integration.
    create_time str
    The time when the integration was created, in Universal Coordinated Time (UTC).
    id str
    The provider-assigned unique ID for this managed resource.
    integration_arn str
    The ARN of the integration.
    createTime String
    The time when the integration was created, in Universal Coordinated Time (UTC).
    id String
    The provider-assigned unique ID for this managed resource.
    integrationArn String
    The ARN of the integration.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native