Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. opensearch
  5. OutboundConnection
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.opensearch.OutboundConnection

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Manages an AWS Opensearch Outbound Connection.

Example Usage

Basic Usage

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

const current = aws.getCallerIdentity({});
const currentGetRegion = aws.getRegion({});
const foo = new aws.opensearch.OutboundConnection("foo", {
    connectionAlias: "outbound_connection",
    connectionMode: "DIRECT",
    localDomainInfo: {
        ownerId: current.then(current => current.accountId),
        region: currentGetRegion.then(currentGetRegion => currentGetRegion.name),
        domainName: localDomain.domainName,
    },
    remoteDomainInfo: {
        ownerId: current.then(current => current.accountId),
        region: currentGetRegion.then(currentGetRegion => currentGetRegion.name),
        domainName: remoteDomain.domainName,
    },
});
Copy
import pulumi
import pulumi_aws as aws

current = aws.get_caller_identity()
current_get_region = aws.get_region()
foo = aws.opensearch.OutboundConnection("foo",
    connection_alias="outbound_connection",
    connection_mode="DIRECT",
    local_domain_info={
        "owner_id": current.account_id,
        "region": current_get_region.name,
        "domain_name": local_domain["domainName"],
    },
    remote_domain_info={
        "owner_id": current.account_id,
        "region": current_get_region.name,
        "domain_name": remote_domain["domainName"],
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := aws.GetCallerIdentity(ctx, &aws.GetCallerIdentityArgs{}, nil)
		if err != nil {
			return err
		}
		currentGetRegion, err := aws.GetRegion(ctx, &aws.GetRegionArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = opensearch.NewOutboundConnection(ctx, "foo", &opensearch.OutboundConnectionArgs{
			ConnectionAlias: pulumi.String("outbound_connection"),
			ConnectionMode:  pulumi.String("DIRECT"),
			LocalDomainInfo: &opensearch.OutboundConnectionLocalDomainInfoArgs{
				OwnerId:    pulumi.String(current.AccountId),
				Region:     pulumi.String(currentGetRegion.Name),
				DomainName: pulumi.Any(localDomain.DomainName),
			},
			RemoteDomainInfo: &opensearch.OutboundConnectionRemoteDomainInfoArgs{
				OwnerId:    pulumi.String(current.AccountId),
				Region:     pulumi.String(currentGetRegion.Name),
				DomainName: pulumi.Any(remoteDomain.DomainName),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var current = Aws.GetCallerIdentity.Invoke();

    var currentGetRegion = Aws.GetRegion.Invoke();

    var foo = new Aws.OpenSearch.OutboundConnection("foo", new()
    {
        ConnectionAlias = "outbound_connection",
        ConnectionMode = "DIRECT",
        LocalDomainInfo = new Aws.OpenSearch.Inputs.OutboundConnectionLocalDomainInfoArgs
        {
            OwnerId = current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId),
            Region = currentGetRegion.Apply(getRegionResult => getRegionResult.Name),
            DomainName = localDomain.DomainName,
        },
        RemoteDomainInfo = new Aws.OpenSearch.Inputs.OutboundConnectionRemoteDomainInfoArgs
        {
            OwnerId = current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId),
            Region = currentGetRegion.Apply(getRegionResult => getRegionResult.Name),
            DomainName = remoteDomain.DomainName,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetCallerIdentityArgs;
import com.pulumi.aws.inputs.GetRegionArgs;
import com.pulumi.aws.opensearch.OutboundConnection;
import com.pulumi.aws.opensearch.OutboundConnectionArgs;
import com.pulumi.aws.opensearch.inputs.OutboundConnectionLocalDomainInfoArgs;
import com.pulumi.aws.opensearch.inputs.OutboundConnectionRemoteDomainInfoArgs;
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 current = AwsFunctions.getCallerIdentity(GetCallerIdentityArgs.builder()
            .build());

        final var currentGetRegion = AwsFunctions.getRegion(GetRegionArgs.builder()
            .build());

        var foo = new OutboundConnection("foo", OutboundConnectionArgs.builder()
            .connectionAlias("outbound_connection")
            .connectionMode("DIRECT")
            .localDomainInfo(OutboundConnectionLocalDomainInfoArgs.builder()
                .ownerId(current.accountId())
                .region(currentGetRegion.name())
                .domainName(localDomain.domainName())
                .build())
            .remoteDomainInfo(OutboundConnectionRemoteDomainInfoArgs.builder()
                .ownerId(current.accountId())
                .region(currentGetRegion.name())
                .domainName(remoteDomain.domainName())
                .build())
            .build());

    }
}
Copy
resources:
  foo:
    type: aws:opensearch:OutboundConnection
    properties:
      connectionAlias: outbound_connection
      connectionMode: DIRECT
      localDomainInfo:
        ownerId: ${current.accountId}
        region: ${currentGetRegion.name}
        domainName: ${localDomain.domainName}
      remoteDomainInfo:
        ownerId: ${current.accountId}
        region: ${currentGetRegion.name}
        domainName: ${remoteDomain.domainName}
variables:
  current:
    fn::invoke:
      function: aws:getCallerIdentity
      arguments: {}
  currentGetRegion:
    fn::invoke:
      function: aws:getRegion
      arguments: {}
Copy

Create OutboundConnection Resource

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

Constructor syntax

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

@overload
def OutboundConnection(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       connection_alias: Optional[str] = None,
                       local_domain_info: Optional[OutboundConnectionLocalDomainInfoArgs] = None,
                       remote_domain_info: Optional[OutboundConnectionRemoteDomainInfoArgs] = None,
                       accept_connection: Optional[bool] = None,
                       connection_mode: Optional[str] = None,
                       connection_properties: Optional[OutboundConnectionConnectionPropertiesArgs] = None)
func NewOutboundConnection(ctx *Context, name string, args OutboundConnectionArgs, opts ...ResourceOption) (*OutboundConnection, error)
public OutboundConnection(string name, OutboundConnectionArgs args, CustomResourceOptions? opts = null)
public OutboundConnection(String name, OutboundConnectionArgs args)
public OutboundConnection(String name, OutboundConnectionArgs args, CustomResourceOptions options)

type: aws:opensearch:OutboundConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OutboundConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OutboundConnectionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OutboundConnectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OutboundConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OutboundConnectionArgs
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 outboundConnectionResource = new Aws.OpenSearch.OutboundConnection("outboundConnectionResource", new()
{
    ConnectionAlias = "string",
    LocalDomainInfo = new Aws.OpenSearch.Inputs.OutboundConnectionLocalDomainInfoArgs
    {
        DomainName = "string",
        OwnerId = "string",
        Region = "string",
    },
    RemoteDomainInfo = new Aws.OpenSearch.Inputs.OutboundConnectionRemoteDomainInfoArgs
    {
        DomainName = "string",
        OwnerId = "string",
        Region = "string",
    },
    AcceptConnection = false,
    ConnectionMode = "string",
    ConnectionProperties = new Aws.OpenSearch.Inputs.OutboundConnectionConnectionPropertiesArgs
    {
        CrossClusterSearch = new Aws.OpenSearch.Inputs.OutboundConnectionConnectionPropertiesCrossClusterSearchArgs
        {
            SkipUnavailable = "string",
        },
        Endpoint = "string",
    },
});
Copy
example, err := opensearch.NewOutboundConnection(ctx, "outboundConnectionResource", &opensearch.OutboundConnectionArgs{
	ConnectionAlias: pulumi.String("string"),
	LocalDomainInfo: &opensearch.OutboundConnectionLocalDomainInfoArgs{
		DomainName: pulumi.String("string"),
		OwnerId:    pulumi.String("string"),
		Region:     pulumi.String("string"),
	},
	RemoteDomainInfo: &opensearch.OutboundConnectionRemoteDomainInfoArgs{
		DomainName: pulumi.String("string"),
		OwnerId:    pulumi.String("string"),
		Region:     pulumi.String("string"),
	},
	AcceptConnection: pulumi.Bool(false),
	ConnectionMode:   pulumi.String("string"),
	ConnectionProperties: &opensearch.OutboundConnectionConnectionPropertiesArgs{
		CrossClusterSearch: &opensearch.OutboundConnectionConnectionPropertiesCrossClusterSearchArgs{
			SkipUnavailable: pulumi.String("string"),
		},
		Endpoint: pulumi.String("string"),
	},
})
Copy
var outboundConnectionResource = new OutboundConnection("outboundConnectionResource", OutboundConnectionArgs.builder()
    .connectionAlias("string")
    .localDomainInfo(OutboundConnectionLocalDomainInfoArgs.builder()
        .domainName("string")
        .ownerId("string")
        .region("string")
        .build())
    .remoteDomainInfo(OutboundConnectionRemoteDomainInfoArgs.builder()
        .domainName("string")
        .ownerId("string")
        .region("string")
        .build())
    .acceptConnection(false)
    .connectionMode("string")
    .connectionProperties(OutboundConnectionConnectionPropertiesArgs.builder()
        .crossClusterSearch(OutboundConnectionConnectionPropertiesCrossClusterSearchArgs.builder()
            .skipUnavailable("string")
            .build())
        .endpoint("string")
        .build())
    .build());
Copy
outbound_connection_resource = aws.opensearch.OutboundConnection("outboundConnectionResource",
    connection_alias="string",
    local_domain_info={
        "domain_name": "string",
        "owner_id": "string",
        "region": "string",
    },
    remote_domain_info={
        "domain_name": "string",
        "owner_id": "string",
        "region": "string",
    },
    accept_connection=False,
    connection_mode="string",
    connection_properties={
        "cross_cluster_search": {
            "skip_unavailable": "string",
        },
        "endpoint": "string",
    })
Copy
const outboundConnectionResource = new aws.opensearch.OutboundConnection("outboundConnectionResource", {
    connectionAlias: "string",
    localDomainInfo: {
        domainName: "string",
        ownerId: "string",
        region: "string",
    },
    remoteDomainInfo: {
        domainName: "string",
        ownerId: "string",
        region: "string",
    },
    acceptConnection: false,
    connectionMode: "string",
    connectionProperties: {
        crossClusterSearch: {
            skipUnavailable: "string",
        },
        endpoint: "string",
    },
});
Copy
type: aws:opensearch:OutboundConnection
properties:
    acceptConnection: false
    connectionAlias: string
    connectionMode: string
    connectionProperties:
        crossClusterSearch:
            skipUnavailable: string
        endpoint: string
    localDomainInfo:
        domainName: string
        ownerId: string
        region: string
    remoteDomainInfo:
        domainName: string
        ownerId: string
        region: string
Copy

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

ConnectionAlias
This property is required.
Changes to this property will trigger replacement.
string
Specifies the connection alias that will be used by the customer for this connection.
LocalDomainInfo
This property is required.
Changes to this property will trigger replacement.
OutboundConnectionLocalDomainInfo
Configuration block for the local Opensearch domain.
RemoteDomainInfo
This property is required.
Changes to this property will trigger replacement.
OutboundConnectionRemoteDomainInfo
Configuration block for the remote Opensearch domain.
AcceptConnection Changes to this property will trigger replacement. bool
Accepts the connection.
ConnectionMode Changes to this property will trigger replacement. string
Specifies the connection mode. Accepted values are DIRECT or VPC_ENDPOINT.
ConnectionProperties OutboundConnectionConnectionProperties
Configuration block for the outbound connection.
ConnectionAlias
This property is required.
Changes to this property will trigger replacement.
string
Specifies the connection alias that will be used by the customer for this connection.
LocalDomainInfo
This property is required.
Changes to this property will trigger replacement.
OutboundConnectionLocalDomainInfoArgs
Configuration block for the local Opensearch domain.
RemoteDomainInfo
This property is required.
Changes to this property will trigger replacement.
OutboundConnectionRemoteDomainInfoArgs
Configuration block for the remote Opensearch domain.
AcceptConnection Changes to this property will trigger replacement. bool
Accepts the connection.
ConnectionMode Changes to this property will trigger replacement. string
Specifies the connection mode. Accepted values are DIRECT or VPC_ENDPOINT.
ConnectionProperties OutboundConnectionConnectionPropertiesArgs
Configuration block for the outbound connection.
connectionAlias
This property is required.
Changes to this property will trigger replacement.
String
Specifies the connection alias that will be used by the customer for this connection.
localDomainInfo
This property is required.
Changes to this property will trigger replacement.
OutboundConnectionLocalDomainInfo
Configuration block for the local Opensearch domain.
remoteDomainInfo
This property is required.
Changes to this property will trigger replacement.
OutboundConnectionRemoteDomainInfo
Configuration block for the remote Opensearch domain.
acceptConnection Changes to this property will trigger replacement. Boolean
Accepts the connection.
connectionMode Changes to this property will trigger replacement. String
Specifies the connection mode. Accepted values are DIRECT or VPC_ENDPOINT.
connectionProperties OutboundConnectionConnectionProperties
Configuration block for the outbound connection.
connectionAlias
This property is required.
Changes to this property will trigger replacement.
string
Specifies the connection alias that will be used by the customer for this connection.
localDomainInfo
This property is required.
Changes to this property will trigger replacement.
OutboundConnectionLocalDomainInfo
Configuration block for the local Opensearch domain.
remoteDomainInfo
This property is required.
Changes to this property will trigger replacement.
OutboundConnectionRemoteDomainInfo
Configuration block for the remote Opensearch domain.
acceptConnection Changes to this property will trigger replacement. boolean
Accepts the connection.
connectionMode Changes to this property will trigger replacement. string
Specifies the connection mode. Accepted values are DIRECT or VPC_ENDPOINT.
connectionProperties OutboundConnectionConnectionProperties
Configuration block for the outbound connection.
connection_alias
This property is required.
Changes to this property will trigger replacement.
str
Specifies the connection alias that will be used by the customer for this connection.
local_domain_info
This property is required.
Changes to this property will trigger replacement.
OutboundConnectionLocalDomainInfoArgs
Configuration block for the local Opensearch domain.
remote_domain_info
This property is required.
Changes to this property will trigger replacement.
OutboundConnectionRemoteDomainInfoArgs
Configuration block for the remote Opensearch domain.
accept_connection Changes to this property will trigger replacement. bool
Accepts the connection.
connection_mode Changes to this property will trigger replacement. str
Specifies the connection mode. Accepted values are DIRECT or VPC_ENDPOINT.
connection_properties OutboundConnectionConnectionPropertiesArgs
Configuration block for the outbound connection.
connectionAlias
This property is required.
Changes to this property will trigger replacement.
String
Specifies the connection alias that will be used by the customer for this connection.
localDomainInfo
This property is required.
Changes to this property will trigger replacement.
Property Map
Configuration block for the local Opensearch domain.
remoteDomainInfo
This property is required.
Changes to this property will trigger replacement.
Property Map
Configuration block for the remote Opensearch domain.
acceptConnection Changes to this property will trigger replacement. Boolean
Accepts the connection.
connectionMode Changes to this property will trigger replacement. String
Specifies the connection mode. Accepted values are DIRECT or VPC_ENDPOINT.
connectionProperties Property Map
Configuration block for the outbound connection.

Outputs

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

ConnectionStatus string
Status of the connection request.
Id string
The provider-assigned unique ID for this managed resource.
ConnectionStatus string
Status of the connection request.
Id string
The provider-assigned unique ID for this managed resource.
connectionStatus String
Status of the connection request.
id String
The provider-assigned unique ID for this managed resource.
connectionStatus string
Status of the connection request.
id string
The provider-assigned unique ID for this managed resource.
connection_status str
Status of the connection request.
id str
The provider-assigned unique ID for this managed resource.
connectionStatus String
Status of the connection request.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing OutboundConnection Resource

Get an existing OutboundConnection 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?: OutboundConnectionState, opts?: CustomResourceOptions): OutboundConnection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accept_connection: Optional[bool] = None,
        connection_alias: Optional[str] = None,
        connection_mode: Optional[str] = None,
        connection_properties: Optional[OutboundConnectionConnectionPropertiesArgs] = None,
        connection_status: Optional[str] = None,
        local_domain_info: Optional[OutboundConnectionLocalDomainInfoArgs] = None,
        remote_domain_info: Optional[OutboundConnectionRemoteDomainInfoArgs] = None) -> OutboundConnection
func GetOutboundConnection(ctx *Context, name string, id IDInput, state *OutboundConnectionState, opts ...ResourceOption) (*OutboundConnection, error)
public static OutboundConnection Get(string name, Input<string> id, OutboundConnectionState? state, CustomResourceOptions? opts = null)
public static OutboundConnection get(String name, Output<String> id, OutboundConnectionState state, CustomResourceOptions options)
resources:  _:    type: aws:opensearch:OutboundConnection    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AcceptConnection Changes to this property will trigger replacement. bool
Accepts the connection.
ConnectionAlias Changes to this property will trigger replacement. string
Specifies the connection alias that will be used by the customer for this connection.
ConnectionMode Changes to this property will trigger replacement. string
Specifies the connection mode. Accepted values are DIRECT or VPC_ENDPOINT.
ConnectionProperties OutboundConnectionConnectionProperties
Configuration block for the outbound connection.
ConnectionStatus string
Status of the connection request.
LocalDomainInfo Changes to this property will trigger replacement. OutboundConnectionLocalDomainInfo
Configuration block for the local Opensearch domain.
RemoteDomainInfo Changes to this property will trigger replacement. OutboundConnectionRemoteDomainInfo
Configuration block for the remote Opensearch domain.
AcceptConnection Changes to this property will trigger replacement. bool
Accepts the connection.
ConnectionAlias Changes to this property will trigger replacement. string
Specifies the connection alias that will be used by the customer for this connection.
ConnectionMode Changes to this property will trigger replacement. string
Specifies the connection mode. Accepted values are DIRECT or VPC_ENDPOINT.
ConnectionProperties OutboundConnectionConnectionPropertiesArgs
Configuration block for the outbound connection.
ConnectionStatus string
Status of the connection request.
LocalDomainInfo Changes to this property will trigger replacement. OutboundConnectionLocalDomainInfoArgs
Configuration block for the local Opensearch domain.
RemoteDomainInfo Changes to this property will trigger replacement. OutboundConnectionRemoteDomainInfoArgs
Configuration block for the remote Opensearch domain.
acceptConnection Changes to this property will trigger replacement. Boolean
Accepts the connection.
connectionAlias Changes to this property will trigger replacement. String
Specifies the connection alias that will be used by the customer for this connection.
connectionMode Changes to this property will trigger replacement. String
Specifies the connection mode. Accepted values are DIRECT or VPC_ENDPOINT.
connectionProperties OutboundConnectionConnectionProperties
Configuration block for the outbound connection.
connectionStatus String
Status of the connection request.
localDomainInfo Changes to this property will trigger replacement. OutboundConnectionLocalDomainInfo
Configuration block for the local Opensearch domain.
remoteDomainInfo Changes to this property will trigger replacement. OutboundConnectionRemoteDomainInfo
Configuration block for the remote Opensearch domain.
acceptConnection Changes to this property will trigger replacement. boolean
Accepts the connection.
connectionAlias Changes to this property will trigger replacement. string
Specifies the connection alias that will be used by the customer for this connection.
connectionMode Changes to this property will trigger replacement. string
Specifies the connection mode. Accepted values are DIRECT or VPC_ENDPOINT.
connectionProperties OutboundConnectionConnectionProperties
Configuration block for the outbound connection.
connectionStatus string
Status of the connection request.
localDomainInfo Changes to this property will trigger replacement. OutboundConnectionLocalDomainInfo
Configuration block for the local Opensearch domain.
remoteDomainInfo Changes to this property will trigger replacement. OutboundConnectionRemoteDomainInfo
Configuration block for the remote Opensearch domain.
accept_connection Changes to this property will trigger replacement. bool
Accepts the connection.
connection_alias Changes to this property will trigger replacement. str
Specifies the connection alias that will be used by the customer for this connection.
connection_mode Changes to this property will trigger replacement. str
Specifies the connection mode. Accepted values are DIRECT or VPC_ENDPOINT.
connection_properties OutboundConnectionConnectionPropertiesArgs
Configuration block for the outbound connection.
connection_status str
Status of the connection request.
local_domain_info Changes to this property will trigger replacement. OutboundConnectionLocalDomainInfoArgs
Configuration block for the local Opensearch domain.
remote_domain_info Changes to this property will trigger replacement. OutboundConnectionRemoteDomainInfoArgs
Configuration block for the remote Opensearch domain.
acceptConnection Changes to this property will trigger replacement. Boolean
Accepts the connection.
connectionAlias Changes to this property will trigger replacement. String
Specifies the connection alias that will be used by the customer for this connection.
connectionMode Changes to this property will trigger replacement. String
Specifies the connection mode. Accepted values are DIRECT or VPC_ENDPOINT.
connectionProperties Property Map
Configuration block for the outbound connection.
connectionStatus String
Status of the connection request.
localDomainInfo Changes to this property will trigger replacement. Property Map
Configuration block for the local Opensearch domain.
remoteDomainInfo Changes to this property will trigger replacement. Property Map
Configuration block for the remote Opensearch domain.

Supporting Types

OutboundConnectionConnectionProperties
, OutboundConnectionConnectionPropertiesArgs

CrossClusterSearch Changes to this property will trigger replacement. OutboundConnectionConnectionPropertiesCrossClusterSearch
Configuration block for cross cluster search.
Endpoint string
The endpoint of the remote domain, is only set when connection_mode is VPC_ENDPOINT and accept_connection is TRUE.
CrossClusterSearch Changes to this property will trigger replacement. OutboundConnectionConnectionPropertiesCrossClusterSearch
Configuration block for cross cluster search.
Endpoint string
The endpoint of the remote domain, is only set when connection_mode is VPC_ENDPOINT and accept_connection is TRUE.
crossClusterSearch Changes to this property will trigger replacement. OutboundConnectionConnectionPropertiesCrossClusterSearch
Configuration block for cross cluster search.
endpoint String
The endpoint of the remote domain, is only set when connection_mode is VPC_ENDPOINT and accept_connection is TRUE.
crossClusterSearch Changes to this property will trigger replacement. OutboundConnectionConnectionPropertiesCrossClusterSearch
Configuration block for cross cluster search.
endpoint string
The endpoint of the remote domain, is only set when connection_mode is VPC_ENDPOINT and accept_connection is TRUE.
cross_cluster_search Changes to this property will trigger replacement. OutboundConnectionConnectionPropertiesCrossClusterSearch
Configuration block for cross cluster search.
endpoint str
The endpoint of the remote domain, is only set when connection_mode is VPC_ENDPOINT and accept_connection is TRUE.
crossClusterSearch Changes to this property will trigger replacement. Property Map
Configuration block for cross cluster search.
endpoint String
The endpoint of the remote domain, is only set when connection_mode is VPC_ENDPOINT and accept_connection is TRUE.

OutboundConnectionConnectionPropertiesCrossClusterSearch
, OutboundConnectionConnectionPropertiesCrossClusterSearchArgs

SkipUnavailable Changes to this property will trigger replacement. string
Skips unavailable clusters and can only be used for cross-cluster searches. Accepted values are ENABLED or DISABLED.
SkipUnavailable Changes to this property will trigger replacement. string
Skips unavailable clusters and can only be used for cross-cluster searches. Accepted values are ENABLED or DISABLED.
skipUnavailable Changes to this property will trigger replacement. String
Skips unavailable clusters and can only be used for cross-cluster searches. Accepted values are ENABLED or DISABLED.
skipUnavailable Changes to this property will trigger replacement. string
Skips unavailable clusters and can only be used for cross-cluster searches. Accepted values are ENABLED or DISABLED.
skip_unavailable Changes to this property will trigger replacement. str
Skips unavailable clusters and can only be used for cross-cluster searches. Accepted values are ENABLED or DISABLED.
skipUnavailable Changes to this property will trigger replacement. String
Skips unavailable clusters and can only be used for cross-cluster searches. Accepted values are ENABLED or DISABLED.

OutboundConnectionLocalDomainInfo
, OutboundConnectionLocalDomainInfoArgs

DomainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the local domain.
OwnerId
This property is required.
Changes to this property will trigger replacement.
string
The Account ID of the owner of the local domain.
Region
This property is required.
Changes to this property will trigger replacement.
string
The region of the local domain.
DomainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the local domain.
OwnerId
This property is required.
Changes to this property will trigger replacement.
string
The Account ID of the owner of the local domain.
Region
This property is required.
Changes to this property will trigger replacement.
string
The region of the local domain.
domainName
This property is required.
Changes to this property will trigger replacement.
String
The name of the local domain.
ownerId
This property is required.
Changes to this property will trigger replacement.
String
The Account ID of the owner of the local domain.
region
This property is required.
Changes to this property will trigger replacement.
String
The region of the local domain.
domainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the local domain.
ownerId
This property is required.
Changes to this property will trigger replacement.
string
The Account ID of the owner of the local domain.
region
This property is required.
Changes to this property will trigger replacement.
string
The region of the local domain.
domain_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the local domain.
owner_id
This property is required.
Changes to this property will trigger replacement.
str
The Account ID of the owner of the local domain.
region
This property is required.
Changes to this property will trigger replacement.
str
The region of the local domain.
domainName
This property is required.
Changes to this property will trigger replacement.
String
The name of the local domain.
ownerId
This property is required.
Changes to this property will trigger replacement.
String
The Account ID of the owner of the local domain.
region
This property is required.
Changes to this property will trigger replacement.
String
The region of the local domain.

OutboundConnectionRemoteDomainInfo
, OutboundConnectionRemoteDomainInfoArgs

DomainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the remote domain.
OwnerId
This property is required.
Changes to this property will trigger replacement.
string
The Account ID of the owner of the remote domain.
Region
This property is required.
Changes to this property will trigger replacement.
string
The region of the remote domain.
DomainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the remote domain.
OwnerId
This property is required.
Changes to this property will trigger replacement.
string
The Account ID of the owner of the remote domain.
Region
This property is required.
Changes to this property will trigger replacement.
string
The region of the remote domain.
domainName
This property is required.
Changes to this property will trigger replacement.
String
The name of the remote domain.
ownerId
This property is required.
Changes to this property will trigger replacement.
String
The Account ID of the owner of the remote domain.
region
This property is required.
Changes to this property will trigger replacement.
String
The region of the remote domain.
domainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the remote domain.
ownerId
This property is required.
Changes to this property will trigger replacement.
string
The Account ID of the owner of the remote domain.
region
This property is required.
Changes to this property will trigger replacement.
string
The region of the remote domain.
domain_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the remote domain.
owner_id
This property is required.
Changes to this property will trigger replacement.
str
The Account ID of the owner of the remote domain.
region
This property is required.
Changes to this property will trigger replacement.
str
The region of the remote domain.
domainName
This property is required.
Changes to this property will trigger replacement.
String
The name of the remote domain.
ownerId
This property is required.
Changes to this property will trigger replacement.
String
The Account ID of the owner of the remote domain.
region
This property is required.
Changes to this property will trigger replacement.
String
The region of the remote domain.

Import

Using pulumi import, import AWS Opensearch Outbound Connections using the Outbound Connection ID. For example:

$ pulumi import aws:opensearch/outboundConnection:OutboundConnection foo connection-id
Copy

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 v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws