1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. cfg
  6. Connector
Viewing docs for AWS v7.55.0
published on Friday, Nov 13, 2026 by Pulumi
aws logo aws logo
Viewing docs for AWS v7.55.0
published on Friday, Nov 13, 2026 by Pulumi

    Manages an AWS Config connector that specifies the connection between a third-party cloud service provider and AWS Config.

    A connector is a prerequisite for recording third-party (multi-cloud) resource configurations. For example, it provides the arn referenced by the azure provider block of aws.securityhub.ConnectorV2 to enable Microsoft Azure coverage in Security Hub.

    NOTE: Creating this resource also creates the AWSServiceRoleForConfigThirdParty service-linked role in your account if it does not already exist.

    NOTE: Connectors cannot be updated in place. Changing the azure configuration forces a new resource to be created.

    Before creating a connector, you must configure the corresponding application and federated credentials in your Azure environment. See the Security Hub Azure integration prerequisites for details.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.cfg.Connector("example", {connectorConfiguration: {
        azure: {
            clientIdentifier: "00000000-0000-0000-0000-000000000000",
            tenantIdentifier: "11111111-1111-1111-1111-111111111111",
        },
    }});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.cfg.Connector("example", connector_configuration={
        "azure": {
            "client_identifier": "00000000-0000-0000-0000-000000000000",
            "tenant_identifier": "11111111-1111-1111-1111-111111111111",
        },
    })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cfg"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cfg.NewConnector(ctx, "example", &cfg.ConnectorArgs{
    			ConnectorConfiguration: &cfg.ConnectorConnectorConfigurationArgs{
    				Azure: &cfg.ConnectorConnectorConfigurationAzureArgs{
    					ClientIdentifier: pulumi.String("00000000-0000-0000-0000-000000000000"),
    					TenantIdentifier: pulumi.String("11111111-1111-1111-1111-111111111111"),
    				},
    			},
    		})
    		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.Cfg.Connector("example", new()
        {
            ConnectorConfiguration = new Aws.Cfg.Inputs.ConnectorConnectorConfigurationArgs
            {
                Azure = new Aws.Cfg.Inputs.ConnectorConnectorConfigurationAzureArgs
                {
                    ClientIdentifier = "00000000-0000-0000-0000-000000000000",
                    TenantIdentifier = "11111111-1111-1111-1111-111111111111",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.cfg.Connector;
    import com.pulumi.aws.cfg.ConnectorArgs;
    import com.pulumi.aws.cfg.inputs.ConnectorConnectorConfigurationArgs;
    import com.pulumi.aws.cfg.inputs.ConnectorConnectorConfigurationAzureArgs;
    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 Connector("example", ConnectorArgs.builder()
                .connectorConfiguration(ConnectorConnectorConfigurationArgs.builder()
                    .azure(ConnectorConnectorConfigurationAzureArgs.builder()
                        .clientIdentifier("00000000-0000-0000-0000-000000000000")
                        .tenantIdentifier("11111111-1111-1111-1111-111111111111")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:cfg:Connector
        properties:
          connectorConfiguration:
            azure:
              clientIdentifier: 00000000-0000-0000-0000-000000000000
              tenantIdentifier: 11111111-1111-1111-1111-111111111111
    
    terraform {
      required_providers {
        aws = {
          source = "pulumi/aws"
        }
      }
    }
    
    resource "aws_cfg_connector" "example" {
      lifecycle {
        create_before_destroy = true
      }
      connector_configuration = {
        azure = {
          client_identifier = "00000000-0000-0000-0000-000000000000"
          tenant_identifier = "11111111-1111-1111-1111-111111111111"
        }
      }
    }
    

    Create Connector Resource

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

    Constructor syntax

    new Connector(name: string, args: ConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def Connector(resource_name: str,
                  args: ConnectorArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Connector(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  connector_configuration: Optional[ConnectorConnectorConfigurationArgs] = None,
                  region: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
    func NewConnector(ctx *Context, name string, args ConnectorArgs, opts ...ResourceOption) (*Connector, error)
    public Connector(string name, ConnectorArgs args, CustomResourceOptions? opts = null)
    public Connector(String name, ConnectorArgs args)
    public Connector(String name, ConnectorArgs args, CustomResourceOptions options)
    
    type: aws:cfg:Connector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws_cfg_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ConnectorArgs
    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 ConnectorArgs
    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 ConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectorArgs
    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 connectorResource = new Aws.Cfg.Connector("connectorResource", new()
    {
        ConnectorConfiguration = new Aws.Cfg.Inputs.ConnectorConnectorConfigurationArgs
        {
            Azure = new Aws.Cfg.Inputs.ConnectorConnectorConfigurationAzureArgs
            {
                ClientIdentifier = "string",
                TenantIdentifier = "string",
            },
        },
        Region = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := cfg.NewConnector(ctx, "connectorResource", &cfg.ConnectorArgs{
    	ConnectorConfiguration: &cfg.ConnectorConnectorConfigurationArgs{
    		Azure: &cfg.ConnectorConnectorConfigurationAzureArgs{
    			ClientIdentifier: pulumi.String("string"),
    			TenantIdentifier: pulumi.String("string"),
    		},
    	},
    	Region: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    resource "aws_cfg_connector" "connectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      connector_configuration = {
        azure = {
          client_identifier = "string"
          tenant_identifier = "string"
        }
      }
      region = "string"
      tags = {
        "string" = "string"
      }
    }
    
    var connectorResource = new com.pulumi.aws.cfg.Connector("connectorResource", com.pulumi.aws.cfg.ConnectorArgs.builder()
        .connectorConfiguration(ConnectorConnectorConfigurationArgs.builder()
            .azure(ConnectorConnectorConfigurationAzureArgs.builder()
                .clientIdentifier("string")
                .tenantIdentifier("string")
                .build())
            .build())
        .region("string")
        .tags(Map.of("string", "string"))
        .build());
    
    connector_resource = aws.cfg.Connector("connectorResource",
        connector_configuration={
            "azure": {
                "client_identifier": "string",
                "tenant_identifier": "string",
            },
        },
        region="string",
        tags={
            "string": "string",
        })
    
    const connectorResource = new aws.cfg.Connector("connectorResource", {
        connectorConfiguration: {
            azure: {
                clientIdentifier: "string",
                tenantIdentifier: "string",
            },
        },
        region: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:cfg:Connector
    properties:
        connectorConfiguration:
            azure:
                clientIdentifier: string
                tenantIdentifier: string
        region: string
        tags:
            string: string
    

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

    ConnectorConfiguration ConnectorConnectorConfiguration

    Provider-specific configuration for connecting to the third-party cloud service provider. See connectorConfiguration Block below.

    The following arguments are optional:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ConnectorConfiguration ConnectorConnectorConfigurationArgs

    Provider-specific configuration for connecting to the third-party cloud service provider. See connectorConfiguration Block below.

    The following arguments are optional:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    connector_configuration object

    Provider-specific configuration for connecting to the third-party cloud service provider. See connectorConfiguration Block below.

    The following arguments are optional:

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    connectorConfiguration ConnectorConnectorConfiguration

    Provider-specific configuration for connecting to the third-party cloud service provider. See connectorConfiguration Block below.

    The following arguments are optional:

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    connectorConfiguration ConnectorConnectorConfiguration

    Provider-specific configuration for connecting to the third-party cloud service provider. See connectorConfiguration Block below.

    The following arguments are optional:

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    connector_configuration ConnectorConnectorConfigurationArgs

    Provider-specific configuration for connecting to the third-party cloud service provider. See connectorConfiguration Block below.

    The following arguments are optional:

    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    connectorConfiguration Property Map

    Provider-specific configuration for connecting to the third-party cloud service provider. See connectorConfiguration Block below.

    The following arguments are optional:

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    ARN of the connector.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the connector.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Arn string
    ARN of the connector.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the connector.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the connector.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the connector.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the connector.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the connector.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the connector.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the connector.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn str
    ARN of the connector.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of the connector.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the connector.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the connector.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

    Look up Existing Connector Resource

    Get an existing Connector 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?: ConnectorState, opts?: CustomResourceOptions): Connector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            connector_configuration: Optional[ConnectorConnectorConfigurationArgs] = None,
            name: Optional[str] = None,
            region: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> Connector
    func GetConnector(ctx *Context, name string, id IDInput, state *ConnectorState, opts ...ResourceOption) (*Connector, error)
    public static Connector Get(string name, Input<string> id, ConnectorState? state, CustomResourceOptions? opts = null)
    public static Connector get(String name, Output<String> id, ConnectorState state, CustomResourceOptions options)
    resources:  existingConnector:    type: aws:cfg:Connector    get:      id: ${id}
    import {
      to = aws_cfg_connector.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    state ConnectorState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state ConnectorState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    state ConnectorState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    state ConnectorState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    options CustomResourceOptions
    Bag of options to control resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the connector.
    ConnectorConfiguration ConnectorConnectorConfiguration

    Provider-specific configuration for connecting to the third-party cloud service provider. See connectorConfiguration Block below.

    The following arguments are optional:

    Name string
    Name of the connector.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Arn string
    ARN of the connector.
    ConnectorConfiguration ConnectorConnectorConfigurationArgs

    Provider-specific configuration for connecting to the third-party cloud service provider. See connectorConfiguration Block below.

    The following arguments are optional:

    Name string
    Name of the connector.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the connector.
    connector_configuration object

    Provider-specific configuration for connecting to the third-party cloud service provider. See connectorConfiguration Block below.

    The following arguments are optional:

    name string
    Name of the connector.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the connector.
    connectorConfiguration ConnectorConnectorConfiguration

    Provider-specific configuration for connecting to the third-party cloud service provider. See connectorConfiguration Block below.

    The following arguments are optional:

    name String
    Name of the connector.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the connector.
    connectorConfiguration ConnectorConnectorConfiguration

    Provider-specific configuration for connecting to the third-party cloud service provider. See connectorConfiguration Block below.

    The following arguments are optional:

    name string
    Name of the connector.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn str
    ARN of the connector.
    connector_configuration ConnectorConnectorConfigurationArgs

    Provider-specific configuration for connecting to the third-party cloud service provider. See connectorConfiguration Block below.

    The following arguments are optional:

    name str
    Name of the connector.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the connector.
    connectorConfiguration Property Map

    Provider-specific configuration for connecting to the third-party cloud service provider. See connectorConfiguration Block below.

    The following arguments are optional:

    name String
    Name of the connector.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

    Supporting Types

    ConnectorConnectorConfiguration, ConnectorConnectorConfigurationArgs

    Azure ConnectorConnectorConfigurationAzure
    Configuration for an Azure connector. See azure Block below.
    Azure ConnectorConnectorConfigurationAzure
    Configuration for an Azure connector. See azure Block below.
    azure object
    Configuration for an Azure connector. See azure Block below.
    azure ConnectorConnectorConfigurationAzure
    Configuration for an Azure connector. See azure Block below.
    azure ConnectorConnectorConfigurationAzure
    Configuration for an Azure connector. See azure Block below.
    azure ConnectorConnectorConfigurationAzure
    Configuration for an Azure connector. See azure Block below.
    azure Property Map
    Configuration for an Azure connector. See azure Block below.

    ConnectorConnectorConfigurationAzure, ConnectorConnectorConfigurationAzureArgs

    ClientIdentifier string
    Azure application (client) identifier that AWS uses to authenticate to the Azure environment.
    TenantIdentifier string
    Azure (Microsoft Entra ID) tenant identifier.
    ClientIdentifier string
    Azure application (client) identifier that AWS uses to authenticate to the Azure environment.
    TenantIdentifier string
    Azure (Microsoft Entra ID) tenant identifier.
    client_identifier string
    Azure application (client) identifier that AWS uses to authenticate to the Azure environment.
    tenant_identifier string
    Azure (Microsoft Entra ID) tenant identifier.
    clientIdentifier String
    Azure application (client) identifier that AWS uses to authenticate to the Azure environment.
    tenantIdentifier String
    Azure (Microsoft Entra ID) tenant identifier.
    clientIdentifier string
    Azure application (client) identifier that AWS uses to authenticate to the Azure environment.
    tenantIdentifier string
    Azure (Microsoft Entra ID) tenant identifier.
    client_identifier str
    Azure application (client) identifier that AWS uses to authenticate to the Azure environment.
    tenant_identifier str
    Azure (Microsoft Entra ID) tenant identifier.
    clientIdentifier String
    Azure application (client) identifier that AWS uses to authenticate to the Azure environment.
    tenantIdentifier String
    Azure (Microsoft Entra ID) tenant identifier.

    Import

    Identity Schema

    Required

    • arn (String) ARN of the connector.

    Using pulumi import, import Config connectors using the arn. For example:

    $ pulumi import aws:cfg/connector:Connector example arn:aws:config:us-east-1:123456789012:connector/00000000-0000-0000-0000-000000000000
    

    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 logo
    Viewing docs for AWS v7.55.0
    published on Friday, Nov 13, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial