Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. redshift
  5. Partner
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.redshift.Partner

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Creates a new Amazon Redshift Partner Integration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.redshift.Partner("example", {
    clusterIdentifier: exampleAwsRedshiftCluster.id,
    accountId: "1234567910",
    databaseName: exampleAwsRedshiftCluster.databaseName,
    partnerName: "example",
});

    import pulumi
import pulumi_aws as aws

example = aws.redshift.Partner("example",
    cluster_identifier=example_aws_redshift_cluster["id"],
    account_id="1234567910",
    database_name=example_aws_redshift_cluster["databaseName"],
    partner_name="example")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/redshift"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redshift.NewPartner(ctx, "example", &redshift.PartnerArgs{
			ClusterIdentifier: pulumi.Any(exampleAwsRedshiftCluster.Id),
			AccountId:         pulumi.String("1234567910"),
			DatabaseName:      pulumi.Any(exampleAwsRedshiftCluster.DatabaseName),
			PartnerName:       pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.RedShift.Partner("example", new()
    {
        ClusterIdentifier = exampleAwsRedshiftCluster.Id,
        AccountId = "1234567910",
        DatabaseName = exampleAwsRedshiftCluster.DatabaseName,
        PartnerName = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.Partner;
import com.pulumi.aws.redshift.PartnerArgs;
import java.util.List;
import java.util.ArrayList;
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 Partner("example", PartnerArgs.builder()
            .clusterIdentifier(exampleAwsRedshiftCluster.id())
            .accountId(1234567910)
            .databaseName(exampleAwsRedshiftCluster.databaseName())
            .partnerName("example")
            .build());

    }
}

    resources:
  example:
    type: aws:redshift:Partner
    properties:
      clusterIdentifier: ${exampleAwsRedshiftCluster.id}
      accountId: 1.23456791e+09
      databaseName: ${exampleAwsRedshiftCluster.databaseName}
      partnerName: example

    Create Partner Resource

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

    Constructor syntax

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

@overload
def Partner(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            cluster_identifier: Optional[str] = None,
            database_name: Optional[str] = None,
            partner_name: Optional[str] = None)
    func NewPartner(ctx *Context, name string, args PartnerArgs, opts ...ResourceOption) (*Partner, error)
    public Partner(string name, PartnerArgs args, CustomResourceOptions? opts = null)
    public Partner(String name, PartnerArgs args)
public Partner(String name, PartnerArgs args, CustomResourceOptions options)

    type: aws:redshift:Partner
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 PartnerArgs
    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 PartnerArgs
    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 PartnerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PartnerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PartnerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var partnerResource = new Aws.RedShift.Partner("partnerResource", new()
{
    AccountId = "string",
    ClusterIdentifier = "string",
    DatabaseName = "string",
    PartnerName = "string",
});

    example, err := redshift.NewPartner(ctx, "partnerResource", &redshift.PartnerArgs{
	AccountId:         pulumi.String("string"),
	ClusterIdentifier: pulumi.String("string"),
	DatabaseName:      pulumi.String("string"),
	PartnerName:       pulumi.String("string"),
})

    var partnerResource = new Partner("partnerResource", PartnerArgs.builder()
    .accountId("string")
    .clusterIdentifier("string")
    .databaseName("string")
    .partnerName("string")
    .build());

    partner_resource = aws.redshift.Partner("partnerResource",
    account_id="string",
    cluster_identifier="string",
    database_name="string",
    partner_name="string")

    const partnerResource = new aws.redshift.Partner("partnerResource", {
    accountId: "string",
    clusterIdentifier: "string",
    databaseName: "string",
    partnerName: "string",
});

    type: aws:redshift:Partner
properties:
    accountId: string
    clusterIdentifier: string
    databaseName: string
    partnerName: string

    Partner 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 Partner resource accepts the following input properties:

    AccountId string
    The Amazon Web Services account ID that owns the cluster.
    ClusterIdentifier string
    The cluster identifier of the cluster that receives data from the partner.
    DatabaseName string
    The name of the database that receives data from the partner.
    PartnerName string
    The name of the partner that is authorized to send data.
    AccountId string
    The Amazon Web Services account ID that owns the cluster.
    ClusterIdentifier string
    The cluster identifier of the cluster that receives data from the partner.
    DatabaseName string
    The name of the database that receives data from the partner.
    PartnerName string
    The name of the partner that is authorized to send data.
    accountId String
    The Amazon Web Services account ID that owns the cluster.
    clusterIdentifier String
    The cluster identifier of the cluster that receives data from the partner.
    databaseName String
    The name of the database that receives data from the partner.
    partnerName String
    The name of the partner that is authorized to send data.
    accountId string
    The Amazon Web Services account ID that owns the cluster.
    clusterIdentifier string
    The cluster identifier of the cluster that receives data from the partner.
    databaseName string
    The name of the database that receives data from the partner.
    partnerName string
    The name of the partner that is authorized to send data.
    account_id str
    The Amazon Web Services account ID that owns the cluster.
    cluster_identifier str
    The cluster identifier of the cluster that receives data from the partner.
    database_name str
    The name of the database that receives data from the partner.
    partner_name str
    The name of the partner that is authorized to send data.
    accountId String
    The Amazon Web Services account ID that owns the cluster.
    clusterIdentifier String
    The cluster identifier of the cluster that receives data from the partner.
    databaseName String
    The name of the database that receives data from the partner.
    partnerName String
    The name of the partner that is authorized to send data.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    (Optional) The partner integration status.
    StatusMessage string
    (Optional) The status message provided by the partner.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    (Optional) The partner integration status.
    StatusMessage string
    (Optional) The status message provided by the partner.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    (Optional) The partner integration status.
    statusMessage String
    (Optional) The status message provided by the partner.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    (Optional) The partner integration status.
    statusMessage string
    (Optional) The status message provided by the partner.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    (Optional) The partner integration status.
    status_message str
    (Optional) The status message provided by the partner.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    (Optional) The partner integration status.
    statusMessage String
    (Optional) The status message provided by the partner.

    Look up Existing Partner Resource

    Get an existing Partner resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PartnerState, opts?: CustomResourceOptions): Partner
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        cluster_identifier: Optional[str] = None,
        database_name: Optional[str] = None,
        partner_name: Optional[str] = None,
        status: Optional[str] = None,
        status_message: Optional[str] = None) -> Partner
    func GetPartner(ctx *Context, name string, id IDInput, state *PartnerState, opts ...ResourceOption) (*Partner, error)
    public static Partner Get(string name, Input<string> id, PartnerState? state, CustomResourceOptions? opts = null)
    public static Partner get(String name, Output<String> id, PartnerState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    The Amazon Web Services account ID that owns the cluster.
    ClusterIdentifier string
    The cluster identifier of the cluster that receives data from the partner.
    DatabaseName string
    The name of the database that receives data from the partner.
    PartnerName string
    The name of the partner that is authorized to send data.
    Status string
    (Optional) The partner integration status.
    StatusMessage string
    (Optional) The status message provided by the partner.
    AccountId string
    The Amazon Web Services account ID that owns the cluster.
    ClusterIdentifier string
    The cluster identifier of the cluster that receives data from the partner.
    DatabaseName string
    The name of the database that receives data from the partner.
    PartnerName string
    The name of the partner that is authorized to send data.
    Status string
    (Optional) The partner integration status.
    StatusMessage string
    (Optional) The status message provided by the partner.
    accountId String
    The Amazon Web Services account ID that owns the cluster.
    clusterIdentifier String
    The cluster identifier of the cluster that receives data from the partner.
    databaseName String
    The name of the database that receives data from the partner.
    partnerName String
    The name of the partner that is authorized to send data.
    status String
    (Optional) The partner integration status.
    statusMessage String
    (Optional) The status message provided by the partner.
    accountId string
    The Amazon Web Services account ID that owns the cluster.
    clusterIdentifier string
    The cluster identifier of the cluster that receives data from the partner.
    databaseName string
    The name of the database that receives data from the partner.
    partnerName string
    The name of the partner that is authorized to send data.
    status string
    (Optional) The partner integration status.
    statusMessage string
    (Optional) The status message provided by the partner.
    account_id str
    The Amazon Web Services account ID that owns the cluster.
    cluster_identifier str
    The cluster identifier of the cluster that receives data from the partner.
    database_name str
    The name of the database that receives data from the partner.
    partner_name str
    The name of the partner that is authorized to send data.
    status str
    (Optional) The partner integration status.
    status_message str
    (Optional) The status message provided by the partner.
    accountId String
    The Amazon Web Services account ID that owns the cluster.
    clusterIdentifier String
    The cluster identifier of the cluster that receives data from the partner.
    databaseName String
    The name of the database that receives data from the partner.
    partnerName String
    The name of the partner that is authorized to send data.
    status String
    (Optional) The partner integration status.
    statusMessage String
    (Optional) The status message provided by the partner.

    Import

    Using pulumi import, import Redshift usage limits using the id. For example:

    $ pulumi import aws:redshift/partner:Partner example 01234567910:cluster-example-id:example:example

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws