1. Packages
  2. Confluent Cloud
  3. API Docs
  4. getProviderIntegration
Confluent v2.3.0 published on Friday, Sep 27, 2024 by Pulumi

confluentcloud.getProviderIntegration

Explore with Pulumi AI

confluentcloud logo
Confluent v2.3.0 published on Friday, Sep 27, 2024 by Pulumi

    General Availability

    confluentcloud.ProviderIntegration describes a Confluent Provider Integration data source.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as confluentcloud from "@pulumi/confluentcloud";
    
    export = async () => {
        const exampleUsingId = await confluentcloud.getProviderIntegration({
            id: "cspi-4xg0q",
            environment: {
                id: "env-xyz456",
            },
        });
        const exampleUsingName = await confluentcloud.getProviderIntegration({
            displayName: "provider_integration_main",
            environment: {
                id: "env-xyz456",
            },
        });
        return {
            exampleUsingId: exampleUsingId,
            exampleUsingName: exampleUsingName,
        };
    }
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    example_using_id = confluentcloud.get_provider_integration(id="cspi-4xg0q",
        environment={
            "id": "env-xyz456",
        })
    pulumi.export("exampleUsingId", example_using_id)
    example_using_name = confluentcloud.get_provider_integration(display_name="provider_integration_main",
        environment={
            "id": "env-xyz456",
        })
    pulumi.export("exampleUsingName", example_using_name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleUsingId, err := confluentcloud.LookupProviderIntegration(ctx, &confluentcloud.LookupProviderIntegrationArgs{
    			Id: pulumi.StringRef("cspi-4xg0q"),
    			Environment: confluentcloud.GetProviderIntegrationEnvironment{
    				Id: "env-xyz456",
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("exampleUsingId", exampleUsingId)
    		exampleUsingName, err := confluentcloud.LookupProviderIntegration(ctx, &confluentcloud.LookupProviderIntegrationArgs{
    			DisplayName: pulumi.StringRef("provider_integration_main"),
    			Environment: confluentcloud.GetProviderIntegrationEnvironment{
    				Id: "env-xyz456",
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("exampleUsingName", exampleUsingName)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ConfluentCloud = Pulumi.ConfluentCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleUsingId = ConfluentCloud.GetProviderIntegration.Invoke(new()
        {
            Id = "cspi-4xg0q",
            Environment = new ConfluentCloud.Inputs.GetProviderIntegrationEnvironmentInputArgs
            {
                Id = "env-xyz456",
            },
        });
    
        var exampleUsingName = ConfluentCloud.GetProviderIntegration.Invoke(new()
        {
            DisplayName = "provider_integration_main",
            Environment = new ConfluentCloud.Inputs.GetProviderIntegrationEnvironmentInputArgs
            {
                Id = "env-xyz456",
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["exampleUsingId"] = exampleUsingId,
            ["exampleUsingName"] = exampleUsingName,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.confluentcloud.ConfluentcloudFunctions;
    import com.pulumi.confluentcloud.inputs.GetProviderIntegrationArgs;
    import com.pulumi.confluentcloud.inputs.GetProviderIntegrationEnvironmentArgs;
    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) {
            final var exampleUsingId = ConfluentcloudFunctions.getProviderIntegration(GetProviderIntegrationArgs.builder()
                .id("cspi-4xg0q")
                .environment(GetProviderIntegrationEnvironmentArgs.builder()
                    .id("env-xyz456")
                    .build())
                .build());
    
            ctx.export("exampleUsingId", exampleUsingId.applyValue(getProviderIntegrationResult -> getProviderIntegrationResult));
            final var exampleUsingName = ConfluentcloudFunctions.getProviderIntegration(GetProviderIntegrationArgs.builder()
                .displayName("provider_integration_main")
                .environment(GetProviderIntegrationEnvironmentArgs.builder()
                    .id("env-xyz456")
                    .build())
                .build());
    
            ctx.export("exampleUsingName", exampleUsingName.applyValue(getProviderIntegrationResult -> getProviderIntegrationResult));
        }
    }
    
    variables:
      exampleUsingId:
        fn::invoke:
          Function: confluentcloud:getProviderIntegration
          Arguments:
            id: cspi-4xg0q
            environment:
              id: env-xyz456
      exampleUsingName:
        fn::invoke:
          Function: confluentcloud:getProviderIntegration
          Arguments:
            displayName: provider_integration_main
            environment:
              id: env-xyz456
    outputs:
      exampleUsingId: ${exampleUsingId}
      exampleUsingName: ${exampleUsingName}
    

    Using getProviderIntegration

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getProviderIntegration(args: GetProviderIntegrationArgs, opts?: InvokeOptions): Promise<GetProviderIntegrationResult>
    function getProviderIntegrationOutput(args: GetProviderIntegrationOutputArgs, opts?: InvokeOptions): Output<GetProviderIntegrationResult>
    def get_provider_integration(display_name: Optional[str] = None,
                                 environment: Optional[GetProviderIntegrationEnvironment] = None,
                                 id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetProviderIntegrationResult
    def get_provider_integration_output(display_name: Optional[pulumi.Input[str]] = None,
                                 environment: Optional[pulumi.Input[GetProviderIntegrationEnvironmentArgs]] = None,
                                 id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetProviderIntegrationResult]
    func LookupProviderIntegration(ctx *Context, args *LookupProviderIntegrationArgs, opts ...InvokeOption) (*LookupProviderIntegrationResult, error)
    func LookupProviderIntegrationOutput(ctx *Context, args *LookupProviderIntegrationOutputArgs, opts ...InvokeOption) LookupProviderIntegrationResultOutput

    > Note: This function is named LookupProviderIntegration in the Go SDK.

    public static class GetProviderIntegration 
    {
        public static Task<GetProviderIntegrationResult> InvokeAsync(GetProviderIntegrationArgs args, InvokeOptions? opts = null)
        public static Output<GetProviderIntegrationResult> Invoke(GetProviderIntegrationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetProviderIntegrationResult> getProviderIntegration(GetProviderIntegrationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: confluentcloud:index/getProviderIntegration:getProviderIntegration
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Environment Pulumi.ConfluentCloud.Inputs.GetProviderIntegrationEnvironment
    (Required Configuration Block) supports the following:
    DisplayName string
    A human-readable name for the Provider Integration.
    Id string
    The ID of the Provider Integration, for example, cspi-4xg0q.
    Environment GetProviderIntegrationEnvironment
    (Required Configuration Block) supports the following:
    DisplayName string
    A human-readable name for the Provider Integration.
    Id string
    The ID of the Provider Integration, for example, cspi-4xg0q.
    environment GetProviderIntegrationEnvironment
    (Required Configuration Block) supports the following:
    displayName String
    A human-readable name for the Provider Integration.
    id String
    The ID of the Provider Integration, for example, cspi-4xg0q.
    environment GetProviderIntegrationEnvironment
    (Required Configuration Block) supports the following:
    displayName string
    A human-readable name for the Provider Integration.
    id string
    The ID of the Provider Integration, for example, cspi-4xg0q.
    environment GetProviderIntegrationEnvironment
    (Required Configuration Block) supports the following:
    display_name str
    A human-readable name for the Provider Integration.
    id str
    The ID of the Provider Integration, for example, cspi-4xg0q.
    environment Property Map
    (Required Configuration Block) supports the following:
    displayName String
    A human-readable name for the Provider Integration.
    id String
    The ID of the Provider Integration, for example, cspi-4xg0q.

    getProviderIntegration Result

    The following output properties are available:

    Aws List<Pulumi.ConfluentCloud.Outputs.GetProviderIntegrationAw>
    (Required Configuration Block) The AWS-specific Provider Integration config details. It supports the following:
    DisplayName string
    (Required String) A human-readable name for the Provider Integration.
    Environment Pulumi.ConfluentCloud.Outputs.GetProviderIntegrationEnvironment
    (Required Configuration Block) supports the following:
    Id string
    (Required String) The ID of the Environment that the Provider Integration belongs to, for example, env-abc123.
    Usages List<string>
    (Required List of Strings) List of resource CRNs where this provider integration is being used.
    Aws []GetProviderIntegrationAw
    (Required Configuration Block) The AWS-specific Provider Integration config details. It supports the following:
    DisplayName string
    (Required String) A human-readable name for the Provider Integration.
    Environment GetProviderIntegrationEnvironment
    (Required Configuration Block) supports the following:
    Id string
    (Required String) The ID of the Environment that the Provider Integration belongs to, for example, env-abc123.
    Usages []string
    (Required List of Strings) List of resource CRNs where this provider integration is being used.
    aws List<GetProviderIntegrationAw>
    (Required Configuration Block) The AWS-specific Provider Integration config details. It supports the following:
    displayName String
    (Required String) A human-readable name for the Provider Integration.
    environment GetProviderIntegrationEnvironment
    (Required Configuration Block) supports the following:
    id String
    (Required String) The ID of the Environment that the Provider Integration belongs to, for example, env-abc123.
    usages List<String>
    (Required List of Strings) List of resource CRNs where this provider integration is being used.
    aws GetProviderIntegrationAw[]
    (Required Configuration Block) The AWS-specific Provider Integration config details. It supports the following:
    displayName string
    (Required String) A human-readable name for the Provider Integration.
    environment GetProviderIntegrationEnvironment
    (Required Configuration Block) supports the following:
    id string
    (Required String) The ID of the Environment that the Provider Integration belongs to, for example, env-abc123.
    usages string[]
    (Required List of Strings) List of resource CRNs where this provider integration is being used.
    aws Sequence[GetProviderIntegrationAw]
    (Required Configuration Block) The AWS-specific Provider Integration config details. It supports the following:
    display_name str
    (Required String) A human-readable name for the Provider Integration.
    environment GetProviderIntegrationEnvironment
    (Required Configuration Block) supports the following:
    id str
    (Required String) The ID of the Environment that the Provider Integration belongs to, for example, env-abc123.
    usages Sequence[str]
    (Required List of Strings) List of resource CRNs where this provider integration is being used.
    aws List<Property Map>
    (Required Configuration Block) The AWS-specific Provider Integration config details. It supports the following:
    displayName String
    (Required String) A human-readable name for the Provider Integration.
    environment Property Map
    (Required Configuration Block) supports the following:
    id String
    (Required String) The ID of the Environment that the Provider Integration belongs to, for example, env-abc123.
    usages List<String>
    (Required List of Strings) List of resource CRNs where this provider integration is being used.

    Supporting Types

    GetProviderIntegrationAw

    CustomerRoleArn string
    (Required String) Amazon Resource Name (ARN) that identifies the AWS Identity and Access Management (IAM) role that Confluent Cloud assumes when it accesses resources in your AWS account, and must be unique in the same environment.
    ExternalId string
    (Required String) Unique external ID that Confluent Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.
    IamRoleArn string
    (Required String) The IAM role ARN used in Confluent Cloud internally, bundled with customer_role_arn.
    CustomerRoleArn string
    (Required String) Amazon Resource Name (ARN) that identifies the AWS Identity and Access Management (IAM) role that Confluent Cloud assumes when it accesses resources in your AWS account, and must be unique in the same environment.
    ExternalId string
    (Required String) Unique external ID that Confluent Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.
    IamRoleArn string
    (Required String) The IAM role ARN used in Confluent Cloud internally, bundled with customer_role_arn.
    customerRoleArn String
    (Required String) Amazon Resource Name (ARN) that identifies the AWS Identity and Access Management (IAM) role that Confluent Cloud assumes when it accesses resources in your AWS account, and must be unique in the same environment.
    externalId String
    (Required String) Unique external ID that Confluent Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.
    iamRoleArn String
    (Required String) The IAM role ARN used in Confluent Cloud internally, bundled with customer_role_arn.
    customerRoleArn string
    (Required String) Amazon Resource Name (ARN) that identifies the AWS Identity and Access Management (IAM) role that Confluent Cloud assumes when it accesses resources in your AWS account, and must be unique in the same environment.
    externalId string
    (Required String) Unique external ID that Confluent Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.
    iamRoleArn string
    (Required String) The IAM role ARN used in Confluent Cloud internally, bundled with customer_role_arn.
    customer_role_arn str
    (Required String) Amazon Resource Name (ARN) that identifies the AWS Identity and Access Management (IAM) role that Confluent Cloud assumes when it accesses resources in your AWS account, and must be unique in the same environment.
    external_id str
    (Required String) Unique external ID that Confluent Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.
    iam_role_arn str
    (Required String) The IAM role ARN used in Confluent Cloud internally, bundled with customer_role_arn.
    customerRoleArn String
    (Required String) Amazon Resource Name (ARN) that identifies the AWS Identity and Access Management (IAM) role that Confluent Cloud assumes when it accesses resources in your AWS account, and must be unique in the same environment.
    externalId String
    (Required String) Unique external ID that Confluent Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.
    iamRoleArn String
    (Required String) The IAM role ARN used in Confluent Cloud internally, bundled with customer_role_arn.

    GetProviderIntegrationEnvironment

    Id string

    The ID of the Environment that the Provider Integration belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    Id string

    The ID of the Environment that the Provider Integration belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id String

    The ID of the Environment that the Provider Integration belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id string

    The ID of the Environment that the Provider Integration belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id str

    The ID of the Environment that the Provider Integration belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id String

    The ID of the Environment that the Provider Integration belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Confluent v2.3.0 published on Friday, Sep 27, 2024 by Pulumi