We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 7, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 7, 2026 by Pulumi
Resource Type definition for AWS::Glue::Connection
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.
function getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOutputOptions): Output<GetConnectionResult>def get_connection(catalog_id: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(catalog_id: pulumi.Input[Optional[str]] = None,
name: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = 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 Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOutputOptions options)
fn::invoke:
function: aws-native:glue:getConnection
arguments:
# arguments dictionarydata "aws-native_glue_get_connection" "name" {
# arguments
}The following arguments are supported:
- catalog_
id string - The ID of the data catalog to create the catalog object in. Currently, this should be the AWS account ID.
- name string
- The name of the connection.
- catalog_
id str - The ID of the data catalog to create the catalog object in. Currently, this should be the AWS account ID.
- name str
- The name of the connection.
getConnection Result
The following output properties are available:
- Connection
Input Pulumi.Aws Native. Glue. Outputs. Connection Input - The connection properties used for this connection.
- Name string
- The name of the connection.
- object
The collection of tags. Each tag element is associated with a given resource.
Search the CloudFormation User Guide for
AWS::Glue::Connectionfor more information about the expected schema for this property.
- Connection
Input ConnectionInput Type - The connection properties used for this connection.
- Name string
- The name of the connection.
- interface{}
The collection of tags. Each tag element is associated with a given resource.
Search the CloudFormation User Guide for
AWS::Glue::Connectionfor more information about the expected schema for this property.
- connection_
input object - The connection properties used for this connection.
- name string
- The name of the connection.
- any
The collection of tags. Each tag element is associated with a given resource.
Search the CloudFormation User Guide for
AWS::Glue::Connectionfor more information about the expected schema for this property.
- connection
Input ConnectionInput - The connection properties used for this connection.
- name String
- The name of the connection.
- Object
The collection of tags. Each tag element is associated with a given resource.
Search the CloudFormation User Guide for
AWS::Glue::Connectionfor more information about the expected schema for this property.
- connection
Input ConnectionInput - The connection properties used for this connection.
- name string
- The name of the connection.
- any
The collection of tags. Each tag element is associated with a given resource.
Search the CloudFormation User Guide for
AWS::Glue::Connectionfor more information about the expected schema for this property.
- connection_
input ConnectionInput - The connection properties used for this connection.
- name str
- The name of the connection.
- Any
The collection of tags. Each tag element is associated with a given resource.
Search the CloudFormation User Guide for
AWS::Glue::Connectionfor more information about the expected schema for this property.
- connection
Input Property Map - The connection properties used for this connection.
- name String
- The name of the connection.
- Any
The collection of tags. Each tag element is associated with a given resource.
Search the CloudFormation User Guide for
AWS::Glue::Connectionfor more information about the expected schema for this property.
Supporting Types
ConnectionAuthenticationConfiguration
- Authentication
Type string - A structure containing the authentication configuration in the CreateConnection request.
- Basic
Authentication Pulumi.Credentials Aws Native. Glue. Inputs. Connection Basic Authentication Credentials - For supplying basic auth credentials when not providing a SecretArn value
- Custom
Authentication objectCredentials - A structure containing the authentication credentials in the CreateConnection request.
- Kms
Key stringArn - The Amazon Resource Name (ARN) of the KMS key used in the authentication configuration.
- OAuth2Properties
Pulumi.
Aws Native. Glue. Inputs. Connection OAuth2Properties - A structure containing properties for OAuth2 in the CreateConnection request.
- Secret
Arn string - The secret manager ARN to store credentials in the CreateConnection request.
- Authentication
Type string - A structure containing the authentication configuration in the CreateConnection request.
- Basic
Authentication ConnectionCredentials Basic Authentication Credentials - For supplying basic auth credentials when not providing a SecretArn value
- Custom
Authentication interface{}Credentials - A structure containing the authentication credentials in the CreateConnection request.
- Kms
Key stringArn - The Amazon Resource Name (ARN) of the KMS key used in the authentication configuration.
- OAuth2Properties
Connection
OAuth2Properties - A structure containing properties for OAuth2 in the CreateConnection request.
- Secret
Arn string - The secret manager ARN to store credentials in the CreateConnection request.
- authentication_
type string - A structure containing the authentication configuration in the CreateConnection request.
- basic_
authentication_ objectcredentials - For supplying basic auth credentials when not providing a SecretArn value
- custom_
authentication_ anycredentials - A structure containing the authentication credentials in the CreateConnection request.
- kms_
key_ stringarn - The Amazon Resource Name (ARN) of the KMS key used in the authentication configuration.
- o_
auth2_ objectproperties - A structure containing properties for OAuth2 in the CreateConnection request.
- secret_
arn string - The secret manager ARN to store credentials in the CreateConnection request.
- authentication
Type String - A structure containing the authentication configuration in the CreateConnection request.
- basic
Authentication ConnectionCredentials Basic Authentication Credentials - For supplying basic auth credentials when not providing a SecretArn value
- custom
Authentication ObjectCredentials - A structure containing the authentication credentials in the CreateConnection request.
- kms
Key StringArn - The Amazon Resource Name (ARN) of the KMS key used in the authentication configuration.
- o
Auth2Properties ConnectionOAuth2Properties - A structure containing properties for OAuth2 in the CreateConnection request.
- secret
Arn String - The secret manager ARN to store credentials in the CreateConnection request.
- authentication
Type string - A structure containing the authentication configuration in the CreateConnection request.
- basic
Authentication ConnectionCredentials Basic Authentication Credentials - For supplying basic auth credentials when not providing a SecretArn value
- custom
Authentication anyCredentials - A structure containing the authentication credentials in the CreateConnection request.
- kms
Key stringArn - The Amazon Resource Name (ARN) of the KMS key used in the authentication configuration.
- o
Auth2Properties ConnectionOAuth2Properties - A structure containing properties for OAuth2 in the CreateConnection request.
- secret
Arn string - The secret manager ARN to store credentials in the CreateConnection request.
- authentication_
type str - A structure containing the authentication configuration in the CreateConnection request.
- basic_
authentication_ Connectioncredentials Basic Authentication Credentials - For supplying basic auth credentials when not providing a SecretArn value
- custom_
authentication_ Anycredentials - A structure containing the authentication credentials in the CreateConnection request.
- kms_
key_ strarn - The Amazon Resource Name (ARN) of the KMS key used in the authentication configuration.
- o_
auth2_ Connectionproperties OAuth2Properties - A structure containing properties for OAuth2 in the CreateConnection request.
- secret_
arn str - The secret manager ARN to store credentials in the CreateConnection request.
- authentication
Type String - A structure containing the authentication configuration in the CreateConnection request.
- basic
Authentication Property MapCredentials - For supplying basic auth credentials when not providing a SecretArn value
- custom
Authentication AnyCredentials - A structure containing the authentication credentials in the CreateConnection request.
- kms
Key StringArn - The Amazon Resource Name (ARN) of the KMS key used in the authentication configuration.
- o
Auth2Properties Property Map - A structure containing properties for OAuth2 in the CreateConnection request.
- secret
Arn String - The secret manager ARN to store credentials in the CreateConnection request.
ConnectionAuthorizationCodeProperties
- string
- The authorization code used in the authentication configuration.
- Redirect
Uri string - The redirect URI where the user gets redirected to by authorization server when issuing an authorization code.
- string
- The authorization code used in the authentication configuration.
- Redirect
Uri string - The redirect URI where the user gets redirected to by authorization server when issuing an authorization code.
- string
- The authorization code used in the authentication configuration.
- redirect_
uri string - The redirect URI where the user gets redirected to by authorization server when issuing an authorization code.
- String
- The authorization code used in the authentication configuration.
- redirect
Uri String - The redirect URI where the user gets redirected to by authorization server when issuing an authorization code.
- string
- The authorization code used in the authentication configuration.
- redirect
Uri string - The redirect URI where the user gets redirected to by authorization server when issuing an authorization code.
- str
- The authorization code used in the authentication configuration.
- redirect_
uri str - The redirect URI where the user gets redirected to by authorization server when issuing an authorization code.
- String
- The authorization code used in the authentication configuration.
- redirect
Uri String - The redirect URI where the user gets redirected to by authorization server when issuing an authorization code.
ConnectionBasicAuthenticationCredentials
ConnectionInput
- Connection
Type string - The type of the connection that needs to be created.
- Athena
Properties object - Connection properties specific to the Athena compute environment.
- Authentication
Configuration Pulumi.Aws Native. Glue. Inputs. Connection Authentication Configuration - The authentication configuration used to connect to the connection.
- Connection
Properties object - A map of key-value pairs used as parameters for this connection.
- Description string
- A description of the connection.
- Match
Criteria List<string> - A list of criteria that can be used in selecting this connection.
- Name string
- The name of the connection.
- Physical
Connection Pulumi.Requirements Aws Native. Glue. Inputs. Connection Physical Connection Requirements - The physical connection requirements.
- Python
Properties object - Connection properties specific to the Python compute environment.
- Spark
Properties object - Connection properties specific to the Spark compute environment.
- Validate
Credentials bool - A flag to validate the credentials during create connection. Default is true.
- Validate
For List<string>Compute Environments - The compute environments that the specified connection properties are validated against.
- Connection
Type string - The type of the connection that needs to be created.
- Athena
Properties interface{} - Connection properties specific to the Athena compute environment.
- Authentication
Configuration ConnectionAuthentication Configuration - The authentication configuration used to connect to the connection.
- Connection
Properties interface{} - A map of key-value pairs used as parameters for this connection.
- Description string
- A description of the connection.
- Match
Criteria []string - A list of criteria that can be used in selecting this connection.
- Name string
- The name of the connection.
- Physical
Connection ConnectionRequirements Physical Connection Requirements - The physical connection requirements.
- Python
Properties interface{} - Connection properties specific to the Python compute environment.
- Spark
Properties interface{} - Connection properties specific to the Spark compute environment.
- Validate
Credentials bool - A flag to validate the credentials during create connection. Default is true.
- Validate
For []stringCompute Environments - The compute environments that the specified connection properties are validated against.
- connection_
type string - The type of the connection that needs to be created.
- athena_
properties any - Connection properties specific to the Athena compute environment.
- authentication_
configuration object - The authentication configuration used to connect to the connection.
- connection_
properties any - A map of key-value pairs used as parameters for this connection.
- description string
- A description of the connection.
- match_
criteria list(string) - A list of criteria that can be used in selecting this connection.
- name string
- The name of the connection.
- physical_
connection_ objectrequirements - The physical connection requirements.
- python_
properties any - Connection properties specific to the Python compute environment.
- spark_
properties any - Connection properties specific to the Spark compute environment.
- validate_
credentials bool - A flag to validate the credentials during create connection. Default is true.
- validate_
for_ list(string)compute_ environments - The compute environments that the specified connection properties are validated against.
- connection
Type String - The type of the connection that needs to be created.
- athena
Properties Object - Connection properties specific to the Athena compute environment.
- authentication
Configuration ConnectionAuthentication Configuration - The authentication configuration used to connect to the connection.
- connection
Properties Object - A map of key-value pairs used as parameters for this connection.
- description String
- A description of the connection.
- match
Criteria List<String> - A list of criteria that can be used in selecting this connection.
- name String
- The name of the connection.
- physical
Connection ConnectionRequirements Physical Connection Requirements - The physical connection requirements.
- python
Properties Object - Connection properties specific to the Python compute environment.
- spark
Properties Object - Connection properties specific to the Spark compute environment.
- validate
Credentials Boolean - A flag to validate the credentials during create connection. Default is true.
- validate
For List<String>Compute Environments - The compute environments that the specified connection properties are validated against.
- connection
Type string - The type of the connection that needs to be created.
- athena
Properties any - Connection properties specific to the Athena compute environment.
- authentication
Configuration ConnectionAuthentication Configuration - The authentication configuration used to connect to the connection.
- connection
Properties any - A map of key-value pairs used as parameters for this connection.
- description string
- A description of the connection.
- match
Criteria string[] - A list of criteria that can be used in selecting this connection.
- name string
- The name of the connection.
- physical
Connection ConnectionRequirements Physical Connection Requirements - The physical connection requirements.
- python
Properties any - Connection properties specific to the Python compute environment.
- spark
Properties any - Connection properties specific to the Spark compute environment.
- validate
Credentials boolean - A flag to validate the credentials during create connection. Default is true.
- validate
For string[]Compute Environments - The compute environments that the specified connection properties are validated against.
- connection_
type str - The type of the connection that needs to be created.
- athena_
properties Any - Connection properties specific to the Athena compute environment.
- authentication_
configuration ConnectionAuthentication Configuration - The authentication configuration used to connect to the connection.
- connection_
properties Any - A map of key-value pairs used as parameters for this connection.
- description str
- A description of the connection.
- match_
criteria Sequence[str] - A list of criteria that can be used in selecting this connection.
- name str
- The name of the connection.
- physical_
connection_ Connectionrequirements Physical Connection Requirements - The physical connection requirements.
- python_
properties Any - Connection properties specific to the Python compute environment.
- spark_
properties Any - Connection properties specific to the Spark compute environment.
- validate_
credentials bool - A flag to validate the credentials during create connection. Default is true.
- validate_
for_ Sequence[str]compute_ environments - The compute environments that the specified connection properties are validated against.
- connection
Type String - The type of the connection that needs to be created.
- athena
Properties Any - Connection properties specific to the Athena compute environment.
- authentication
Configuration Property Map - The authentication configuration used to connect to the connection.
- connection
Properties Any - A map of key-value pairs used as parameters for this connection.
- description String
- A description of the connection.
- match
Criteria List<String> - A list of criteria that can be used in selecting this connection.
- name String
- The name of the connection.
- physical
Connection Property MapRequirements - The physical connection requirements.
- python
Properties Any - Connection properties specific to the Python compute environment.
- spark
Properties Any - Connection properties specific to the Spark compute environment.
- validate
Credentials Boolean - A flag to validate the credentials during create connection. Default is true.
- validate
For List<String>Compute Environments - The compute environments that the specified connection properties are validated against.
ConnectionOAuth2ClientApplication
- Aws
Managed stringClient Application Reference - The reference to the SaaS-side client app that is AWS managed.
- User
Managed stringClient Application Client Id - The client application clientID if the ClientAppType is USER_MANAGED.
- Aws
Managed stringClient Application Reference - The reference to the SaaS-side client app that is AWS managed.
- User
Managed stringClient Application Client Id - The client application clientID if the ClientAppType is USER_MANAGED.
- aws_
managed_ stringclient_ application_ reference - The reference to the SaaS-side client app that is AWS managed.
- user_
managed_ stringclient_ application_ client_ id - The client application clientID if the ClientAppType is USER_MANAGED.
- aws
Managed StringClient Application Reference - The reference to the SaaS-side client app that is AWS managed.
- user
Managed StringClient Application Client Id - The client application clientID if the ClientAppType is USER_MANAGED.
- aws
Managed stringClient Application Reference - The reference to the SaaS-side client app that is AWS managed.
- user
Managed stringClient Application Client Id - The client application clientID if the ClientAppType is USER_MANAGED.
- aws_
managed_ strclient_ application_ reference - The reference to the SaaS-side client app that is AWS managed.
- user_
managed_ strclient_ application_ client_ id - The client application clientID if the ClientAppType is USER_MANAGED.
- aws
Managed StringClient Application Reference - The reference to the SaaS-side client app that is AWS managed.
- user
Managed StringClient Application Client Id - The client application clientID if the ClientAppType is USER_MANAGED.
ConnectionOAuth2Credentials
- Access
Token string - The access token used in the authentication configuration.
- Jwt
Token string - The JSON Web Token (JWT) used when the authentication type is OAuth2.
- Refresh
Token string - The refresh token used when the authentication type is OAuth2.
- User
Managed stringClient Application Client Secret - The client application client secret if the client application is user managed.
- Access
Token string - The access token used in the authentication configuration.
- Jwt
Token string - The JSON Web Token (JWT) used when the authentication type is OAuth2.
- Refresh
Token string - The refresh token used when the authentication type is OAuth2.
- User
Managed stringClient Application Client Secret - The client application client secret if the client application is user managed.
- access_
token string - The access token used in the authentication configuration.
- jwt_
token string - The JSON Web Token (JWT) used when the authentication type is OAuth2.
- refresh_
token string - The refresh token used when the authentication type is OAuth2.
- user_
managed_ stringclient_ application_ client_ secret - The client application client secret if the client application is user managed.
- access
Token String - The access token used in the authentication configuration.
- jwt
Token String - The JSON Web Token (JWT) used when the authentication type is OAuth2.
- refresh
Token String - The refresh token used when the authentication type is OAuth2.
- user
Managed StringClient Application Client Secret - The client application client secret if the client application is user managed.
- access
Token string - The access token used in the authentication configuration.
- jwt
Token string - The JSON Web Token (JWT) used when the authentication type is OAuth2.
- refresh
Token string - The refresh token used when the authentication type is OAuth2.
- user
Managed stringClient Application Client Secret - The client application client secret if the client application is user managed.
- access_
token str - The access token used in the authentication configuration.
- jwt_
token str - The JSON Web Token (JWT) used when the authentication type is OAuth2.
- refresh_
token str - The refresh token used when the authentication type is OAuth2.
- user_
managed_ strclient_ application_ client_ secret - The client application client secret if the client application is user managed.
- access
Token String - The access token used in the authentication configuration.
- jwt
Token String - The JSON Web Token (JWT) used when the authentication type is OAuth2.
- refresh
Token String - The refresh token used when the authentication type is OAuth2.
- user
Managed StringClient Application Client Secret - The client application client secret if the client application is user managed.
ConnectionOAuth2Properties
-
Pulumi.
Aws Native. Glue. Inputs. Connection Authorization Code Properties - The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type workflow.
- OAuth2Client
Application Pulumi.Aws Native. Glue. Inputs. Connection OAuth2Client Application - The OAuth2 client app used for the connection.
- OAuth2Credentials
Pulumi.
Aws Native. Glue. Inputs. Connection OAuth2Credentials - A structure containing the OAuth2 credentials used in the authentication configuration.
- OAuth2Grant
Type string - The grant type used in the authentication configuration.
- Token
Url string - The URL used in the authentication configuration.
- Token
Url objectParameters Map - A map of key-value pairs used in the authentication configuration.
-
Connection
Authorization Code Properties - The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type workflow.
- OAuth2Client
Application ConnectionOAuth2Client Application - The OAuth2 client app used for the connection.
- OAuth2Credentials
Connection
OAuth2Credentials - A structure containing the OAuth2 credentials used in the authentication configuration.
- OAuth2Grant
Type string - The grant type used in the authentication configuration.
- Token
Url string - The URL used in the authentication configuration.
- Token
Url interface{}Parameters Map - A map of key-value pairs used in the authentication configuration.
- object
- The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type workflow.
- o_
auth2_ objectclient_ application - The OAuth2 client app used for the connection.
- o_
auth2_ objectcredentials - A structure containing the OAuth2 credentials used in the authentication configuration.
- o_
auth2_ stringgrant_ type - The grant type used in the authentication configuration.
- token_
url string - The URL used in the authentication configuration.
- token_
url_ anyparameters_ map - A map of key-value pairs used in the authentication configuration.
-
Connection
Authorization Code Properties - The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type workflow.
- o
Auth2Client ConnectionApplication OAuth2Client Application - The OAuth2 client app used for the connection.
- o
Auth2Credentials ConnectionOAuth2Credentials - A structure containing the OAuth2 credentials used in the authentication configuration.
- o
Auth2Grant StringType - The grant type used in the authentication configuration.
- token
Url String - The URL used in the authentication configuration.
- token
Url ObjectParameters Map - A map of key-value pairs used in the authentication configuration.
-
Connection
Authorization Code Properties - The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type workflow.
- o
Auth2Client ConnectionApplication OAuth2Client Application - The OAuth2 client app used for the connection.
- o
Auth2Credentials ConnectionOAuth2Credentials - A structure containing the OAuth2 credentials used in the authentication configuration.
- o
Auth2Grant stringType - The grant type used in the authentication configuration.
- token
Url string - The URL used in the authentication configuration.
- token
Url anyParameters Map - A map of key-value pairs used in the authentication configuration.
-
Connection
Authorization Code Properties - The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type workflow.
- o_
auth2_ Connectionclient_ application OAuth2Client Application - The OAuth2 client app used for the connection.
- o_
auth2_ Connectioncredentials OAuth2Credentials - A structure containing the OAuth2 credentials used in the authentication configuration.
- o_
auth2_ strgrant_ type - The grant type used in the authentication configuration.
- token_
url str - The URL used in the authentication configuration.
- token_
url_ Anyparameters_ map - A map of key-value pairs used in the authentication configuration.
- Property Map
- The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type workflow.
- o
Auth2Client Property MapApplication - The OAuth2 client app used for the connection.
- o
Auth2Credentials Property Map - A structure containing the OAuth2 credentials used in the authentication configuration.
- o
Auth2Grant StringType - The grant type used in the authentication configuration.
- token
Url String - The URL used in the authentication configuration.
- token
Url AnyParameters Map - A map of key-value pairs used in the authentication configuration.
ConnectionPhysicalConnectionRequirements
- Availability
Zone string - The availability zone where the connection is located.
- Security
Group List<string>Id List - The security group ID list used by the connection.
- Subnet
Id string - The subnet ID used by the connection.
- Availability
Zone string - The availability zone where the connection is located.
- Security
Group []stringId List - The security group ID list used by the connection.
- Subnet
Id string - The subnet ID used by the connection.
- availability_
zone string - The availability zone where the connection is located.
- security_
group_ list(string)id_ list - The security group ID list used by the connection.
- subnet_
id string - The subnet ID used by the connection.
- availability
Zone String - The availability zone where the connection is located.
- security
Group List<String>Id List - The security group ID list used by the connection.
- subnet
Id String - The subnet ID used by the connection.
- availability
Zone string - The availability zone where the connection is located.
- security
Group string[]Id List - The security group ID list used by the connection.
- subnet
Id string - The subnet ID used by the connection.
- availability_
zone str - The availability zone where the connection is located.
- security_
group_ Sequence[str]id_ list - The security group ID list used by the connection.
- subnet_
id str - The subnet ID used by the connection.
- availability
Zone String - The availability zone where the connection is located.
- security
Group List<String>Id List - The security group ID list used by the connection.
- subnet
Id String - The subnet ID used by the connection.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 7, 2026 by Pulumi