AWS Cloud Control v1.25.0, Feb 3 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.25.0 published on Monday, Feb 3, 2025 by Pulumi

aws-native.events.getConnection

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.25.0 published on Monday, Feb 3, 2025 by Pulumi

Using getConnection

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.

TypeScript
Python
Go
C#
Java
YAML

function getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>

def get_connection(name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]

func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput

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

public static class GetConnection 
{
    public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:events:getConnection
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name of the connection.

Name string: Name of the connection.

name String: Name of the connection.

name string: Name of the connection.

name str: Name of the connection.

name String: Name of the connection.

getConnection Result

The following output properties are available:

Arn string

The arn of the connection resource.

AuthParameters Pulumi.AwsNative.Events.Outputs.ConnectionAuthParameters

The authorization parameters to use to authorize with the endpoint.

You must include only authorization parameters for the AuthorizationType you specify.

AuthorizationType Pulumi.AwsNative.Events.ConnectionAuthorizationType

The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

Description string

Description of the connection.

InvocationConnectivityParameters Pulumi.AwsNative.Events.Outputs.InvocationConnectivityParametersProperties

The private resource the HTTP request will be sent to.

SecretArn string

The arn of the secrets manager secret created in the customer account.

Arn string

The arn of the connection resource.

AuthParameters ConnectionAuthParameters

The authorization parameters to use to authorize with the endpoint.

You must include only authorization parameters for the AuthorizationType you specify.

AuthorizationType ConnectionAuthorizationType

The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

Description string

Description of the connection.

InvocationConnectivityParameters InvocationConnectivityParametersProperties

The private resource the HTTP request will be sent to.

SecretArn string

The arn of the secrets manager secret created in the customer account.

arn String

The arn of the connection resource.

authParameters ConnectionAuthParameters

The authorization parameters to use to authorize with the endpoint.

You must include only authorization parameters for the AuthorizationType you specify.

authorizationType ConnectionAuthorizationType

The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

description String

Description of the connection.

invocationConnectivityParameters InvocationConnectivityParametersProperties

The private resource the HTTP request will be sent to.

secretArn String

The arn of the secrets manager secret created in the customer account.

arn string

The arn of the connection resource.

authParameters ConnectionAuthParameters

The authorization parameters to use to authorize with the endpoint.

You must include only authorization parameters for the AuthorizationType you specify.

authorizationType ConnectionAuthorizationType

The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

description string

Description of the connection.

invocationConnectivityParameters InvocationConnectivityParametersProperties

The private resource the HTTP request will be sent to.

secretArn string

The arn of the secrets manager secret created in the customer account.

arn str

The arn of the connection resource.

auth_parameters ConnectionAuthParameters

The authorization parameters to use to authorize with the endpoint.

You must include only authorization parameters for the AuthorizationType you specify.

authorization_type ConnectionAuthorizationType

The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

description str

Description of the connection.

invocation_connectivity_parameters InvocationConnectivityParametersProperties

The private resource the HTTP request will be sent to.

secret_arn str

The arn of the secrets manager secret created in the customer account.

arn String

The arn of the connection resource.

authParameters Property Map

The authorization parameters to use to authorize with the endpoint.

You must include only authorization parameters for the AuthorizationType you specify.

authorizationType "API_KEY" | "BASIC" | "OAUTH_CLIENT_CREDENTIALS"

The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

description String

Description of the connection.

invocationConnectivityParameters Property Map

The private resource the HTTP request will be sent to.

secretArn String

The arn of the secrets manager secret created in the customer account.

Supporting Types

ConnectionApiKeyAuthParameters

ApiKeyName string: The name of the API key to use for authorization.
ApiKeyValue string: The value for the API key to use for authorization.

ApiKeyName string: The name of the API key to use for authorization.
ApiKeyValue string: The value for the API key to use for authorization.

apiKeyName String: The name of the API key to use for authorization.
apiKeyValue String: The value for the API key to use for authorization.

apiKeyName string: The name of the API key to use for authorization.
apiKeyValue string: The value for the API key to use for authorization.

api_key_name str: The name of the API key to use for authorization.
api_key_value str: The value for the API key to use for authorization.

apiKeyName String: The name of the API key to use for authorization.
apiKeyValue String: The value for the API key to use for authorization.

ConnectionAuthParameters

ApiKeyAuthParameters Pulumi.AwsNative.Events.Inputs.ConnectionApiKeyAuthParameters

The API Key parameters to use for authorization.

BasicAuthParameters Pulumi.AwsNative.Events.Inputs.ConnectionBasicAuthParameters

The authorization parameters for Basic authorization.

ConnectivityParameters Pulumi.AwsNative.Events.Inputs.ConnectionConnectivityParameters

For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.

For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .

InvocationHttpParameters Pulumi.AwsNative.Events.Inputs.ConnectionHttpParameters

Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

OAuthParameters Pulumi.AwsNative.Events.Inputs.ConnectionOAuthParameters

The OAuth parameters to use for authorization.

ApiKeyAuthParameters ConnectionApiKeyAuthParameters

The API Key parameters to use for authorization.

BasicAuthParameters ConnectionBasicAuthParameters

The authorization parameters for Basic authorization.

ConnectivityParameters ConnectionConnectivityParameters

For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.

For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .

InvocationHttpParameters ConnectionHttpParameters

Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

OAuthParameters ConnectionOAuthParameters

The OAuth parameters to use for authorization.

apiKeyAuthParameters ConnectionApiKeyAuthParameters

The API Key parameters to use for authorization.

basicAuthParameters ConnectionBasicAuthParameters

The authorization parameters for Basic authorization.

connectivityParameters ConnectionConnectivityParameters

For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.

For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .

invocationHttpParameters ConnectionHttpParameters

Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

oAuthParameters ConnectionOAuthParameters

The OAuth parameters to use for authorization.

apiKeyAuthParameters ConnectionApiKeyAuthParameters

The API Key parameters to use for authorization.

basicAuthParameters ConnectionBasicAuthParameters

The authorization parameters for Basic authorization.

connectivityParameters ConnectionConnectivityParameters

For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.

For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .

invocationHttpParameters ConnectionHttpParameters

Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

oAuthParameters ConnectionOAuthParameters

The OAuth parameters to use for authorization.

api_key_auth_parameters ConnectionApiKeyAuthParameters

The API Key parameters to use for authorization.

basic_auth_parameters ConnectionBasicAuthParameters

The authorization parameters for Basic authorization.

connectivity_parameters ConnectionConnectivityParameters

For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.

For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .

invocation_http_parameters ConnectionHttpParameters

Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

o_auth_parameters ConnectionOAuthParameters

The OAuth parameters to use for authorization.

apiKeyAuthParameters Property Map

The API Key parameters to use for authorization.

basicAuthParameters Property Map

The authorization parameters for Basic authorization.

connectivityParameters Property Map

For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.

For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .

invocationHttpParameters Property Map

Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

oAuthParameters Property Map

The OAuth parameters to use for authorization.

ConnectionAuthorizationType

ConnectionBasicAuthParameters

Password string: The password associated with the user name to use for Basic authorization.
Username string: The user name to use for Basic authorization.

Password string: The password associated with the user name to use for Basic authorization.
Username string: The user name to use for Basic authorization.

password String: The password associated with the user name to use for Basic authorization.
username String: The user name to use for Basic authorization.

password string: The password associated with the user name to use for Basic authorization.
username string: The user name to use for Basic authorization.

password str: The password associated with the user name to use for Basic authorization.
username str: The user name to use for Basic authorization.

password String: The password associated with the user name to use for Basic authorization.
username String: The user name to use for Basic authorization.

ConnectionClientParameters

ClientId string: The client ID to use for OAuth authorization.
ClientSecret string: The client secret assciated with the client ID to use for OAuth authorization.

ClientId string: The client ID to use for OAuth authorization.
ClientSecret string: The client secret assciated with the client ID to use for OAuth authorization.

clientId String: The client ID to use for OAuth authorization.
clientSecret String: The client secret assciated with the client ID to use for OAuth authorization.

clientId string: The client ID to use for OAuth authorization.
clientSecret string: The client secret assciated with the client ID to use for OAuth authorization.

client_id str: The client ID to use for OAuth authorization.
client_secret str: The client secret assciated with the client ID to use for OAuth authorization.

clientId String: The client ID to use for OAuth authorization.
clientSecret String: The client secret assciated with the client ID to use for OAuth authorization.

ConnectionConnectivityParameters

ResourceParameters Pulumi.AwsNative.Events.Inputs.ConnectionResourceParameters: The parameters for EventBridge to use when invoking the resource endpoint.

ResourceParameters ConnectionResourceParameters: The parameters for EventBridge to use when invoking the resource endpoint.

resourceParameters ConnectionResourceParameters: The parameters for EventBridge to use when invoking the resource endpoint.

resourceParameters ConnectionResourceParameters: The parameters for EventBridge to use when invoking the resource endpoint.

resource_parameters ConnectionResourceParameters: The parameters for EventBridge to use when invoking the resource endpoint.

resourceParameters Property Map: The parameters for EventBridge to use when invoking the resource endpoint.

ConnectionHttpParameters

BodyParameters List<Pulumi.AwsNative.Events.Inputs.ConnectionParameter>: Any additional body string parameters for the connection.
HeaderParameters List<Pulumi.AwsNative.Events.Inputs.ConnectionParameter>: Any additional header parameters for the connection.
QueryStringParameters List<Pulumi.AwsNative.Events.Inputs.ConnectionParameter>: Any additional query string parameters for the connection.

BodyParameters []ConnectionParameter: Any additional body string parameters for the connection.
HeaderParameters []ConnectionParameter: Any additional header parameters for the connection.
QueryStringParameters []ConnectionParameter: Any additional query string parameters for the connection.

bodyParameters List<ConnectionParameter>: Any additional body string parameters for the connection.
headerParameters List<ConnectionParameter>: Any additional header parameters for the connection.
queryStringParameters List<ConnectionParameter>: Any additional query string parameters for the connection.

bodyParameters ConnectionParameter[]: Any additional body string parameters for the connection.
headerParameters ConnectionParameter[]: Any additional header parameters for the connection.
queryStringParameters ConnectionParameter[]: Any additional query string parameters for the connection.

body_parameters Sequence[ConnectionParameter]: Any additional body string parameters for the connection.
header_parameters Sequence[ConnectionParameter]: Any additional header parameters for the connection.
query_string_parameters Sequence[ConnectionParameter]: Any additional query string parameters for the connection.

bodyParameters List<Property Map>: Any additional body string parameters for the connection.
headerParameters List<Property Map>: Any additional header parameters for the connection.
queryStringParameters List<Property Map>: Any additional query string parameters for the connection.

ConnectionOAuthParameters

AuthorizationEndpoint string: The URL to the authorization endpoint when OAuth is specified as the authorization type.
ClientParameters Pulumi.AwsNative.Events.Inputs.ConnectionClientParameters: The client parameters for OAuth authorization.
HttpMethod Pulumi.AwsNative.Events.ConnectionOAuthParametersHttpMethod: The method to use for the authorization request.
OAuthHttpParameters Pulumi.AwsNative.Events.Inputs.ConnectionHttpParameters: Details about the additional parameters to use for the connection.

AuthorizationEndpoint string: The URL to the authorization endpoint when OAuth is specified as the authorization type.
ClientParameters ConnectionClientParameters: The client parameters for OAuth authorization.
HttpMethod ConnectionOAuthParametersHttpMethod: The method to use for the authorization request.
OAuthHttpParameters ConnectionHttpParameters: Details about the additional parameters to use for the connection.

authorizationEndpoint String: The URL to the authorization endpoint when OAuth is specified as the authorization type.
clientParameters ConnectionClientParameters: The client parameters for OAuth authorization.
httpMethod ConnectionOAuthParametersHttpMethod: The method to use for the authorization request.
oAuthHttpParameters ConnectionHttpParameters: Details about the additional parameters to use for the connection.

authorizationEndpoint string: The URL to the authorization endpoint when OAuth is specified as the authorization type.
clientParameters ConnectionClientParameters: The client parameters for OAuth authorization.
httpMethod ConnectionOAuthParametersHttpMethod: The method to use for the authorization request.
oAuthHttpParameters ConnectionHttpParameters: Details about the additional parameters to use for the connection.

authorization_endpoint str: The URL to the authorization endpoint when OAuth is specified as the authorization type.
client_parameters ConnectionClientParameters: The client parameters for OAuth authorization.
http_method ConnectionOAuthParametersHttpMethod: The method to use for the authorization request.
o_auth_http_parameters ConnectionHttpParameters: Details about the additional parameters to use for the connection.

authorizationEndpoint String: The URL to the authorization endpoint when OAuth is specified as the authorization type.
clientParameters Property Map: The client parameters for OAuth authorization.
httpMethod "GET" | "POST" | "PUT": The method to use for the authorization request.
oAuthHttpParameters Property Map: Details about the additional parameters to use for the connection.

ConnectionOAuthParametersHttpMethod

ConnectionParameter

Key string: The key for a query string parameter.
Value string: The value associated with the key for the query string parameter.
IsValueSecret bool: Specifies whether the value is secret.

Key string: The key for a query string parameter.
Value string: The value associated with the key for the query string parameter.
IsValueSecret bool: Specifies whether the value is secret.

key String: The key for a query string parameter.
value String: The value associated with the key for the query string parameter.
isValueSecret Boolean: Specifies whether the value is secret.

key string: The key for a query string parameter.
value string: The value associated with the key for the query string parameter.
isValueSecret boolean: Specifies whether the value is secret.

key str: The key for a query string parameter.
value str: The value associated with the key for the query string parameter.
is_value_secret bool: Specifies whether the value is secret.

key String: The key for a query string parameter.
value String: The value associated with the key for the query string parameter.
isValueSecret Boolean: Specifies whether the value is secret.

ConnectionResourceParameters

ResourceConfigurationArn string: The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.
ResourceAssociationArn string: For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.
The value of this property is set by EventBridge . Any value you specify in your template is ignored.

ResourceConfigurationArn string: The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.
ResourceAssociationArn string: For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.
The value of this property is set by EventBridge . Any value you specify in your template is ignored.

resourceConfigurationArn String: The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.
resourceAssociationArn String: For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.
The value of this property is set by EventBridge . Any value you specify in your template is ignored.

resourceConfigurationArn string: The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.
resourceAssociationArn string: For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.
The value of this property is set by EventBridge . Any value you specify in your template is ignored.

resource_configuration_arn str: The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.
resource_association_arn str: For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.
The value of this property is set by EventBridge . Any value you specify in your template is ignored.

resourceConfigurationArn String: The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.
resourceAssociationArn String: For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.
The value of this property is set by EventBridge . Any value you specify in your template is ignored.

InvocationConnectivityParametersProperties

ResourceParameters Pulumi.AwsNative.Events.Inputs.ConnectionResourceParameters: The parameters for EventBridge to use when invoking the resource endpoint.

ResourceParameters ConnectionResourceParameters: The parameters for EventBridge to use when invoking the resource endpoint.

resourceParameters ConnectionResourceParameters: The parameters for EventBridge to use when invoking the resource endpoint.

resourceParameters ConnectionResourceParameters: The parameters for EventBridge to use when invoking the resource endpoint.

resource_parameters ConnectionResourceParameters: The parameters for EventBridge to use when invoking the resource endpoint.

resourceParameters Property Map: The parameters for EventBridge to use when invoking the resource endpoint.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.25.0 published on Monday, Feb 3, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.events.getConnection

On this page

On this page

Using getConnection

getConnection Result

Supporting Types

ConnectionApiKeyAuthParameters

ConnectionAuthParameters

ConnectionAuthorizationType

ConnectionBasicAuthParameters

ConnectionClientParameters

ConnectionConnectivityParameters

ConnectionHttpParameters

ConnectionOAuthParameters

ConnectionOAuthParametersHttpMethod

ConnectionParameter

ConnectionResourceParameters

InvocationConnectivityParametersProperties

Package Details

On this page

On this page