1. Packages
  2. AWS Native
  3. API Docs
  4. rds
  5. Integration

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

aws-native.rds.Integration

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

    Creates 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

    The Integration resource accepts the following input properties:

    SourceArn string
    The Amazon Resource Name (ARN) of the Aurora DB cluster 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 AWS Key Management Service Developer Guide .

    You can only include this parameter if you specify the KMSKeyId parameter.

    DataFilter string
    The data filter for the integration.
    Description string
    The description of the integration.
    IntegrationName string
    The name of the integration.
    KmsKeyId string
    An optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    SourceArn string
    The Amazon Resource Name (ARN) of the Aurora DB cluster 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 AWS Key Management Service Developer Guide .

    You can only include this parameter if you specify the KMSKeyId parameter.

    DataFilter string
    The data filter for the integration.
    Description string
    The description of the integration.
    IntegrationName string
    The name of the integration.
    KmsKeyId string
    An optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    sourceArn String
    The Amazon Resource Name (ARN) of the Aurora DB cluster 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 AWS Key Management Service Developer Guide .

    You can only include this parameter if you specify the KMSKeyId parameter.

    dataFilter String
    The data filter for the integration.
    description String
    The description of the integration.
    integrationName String
    The name of the integration.
    kmsKeyId String
    An optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    sourceArn string
    The Amazon Resource Name (ARN) of the Aurora DB cluster 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 AWS Key Management Service Developer Guide .

    You can only include this parameter if you specify the KMSKeyId parameter.

    dataFilter string
    The data filter for the integration.
    description string
    The description of the integration.
    integrationName string
    The name of the integration.
    kmsKeyId string
    An optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    source_arn str
    The Amazon Resource Name (ARN) of the Aurora DB cluster 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 AWS Key Management Service Developer Guide .

    You can only include this parameter if you specify the KMSKeyId parameter.

    data_filter str
    The data filter for the integration.
    description str
    The description of the integration.
    integration_name str
    The name of the integration.
    kms_key_id str
    An optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    sourceArn String
    The Amazon Resource Name (ARN) of the Aurora DB cluster 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 AWS Key Management Service Developer Guide .

    You can only include this parameter if you specify the KMSKeyId parameter.

    dataFilter String
    The data filter for the integration.
    description String
    The description of the integration.
    integrationName String
    The name of the integration.
    kmsKeyId String
    An optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi