You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Glue::Types::GetConnectionsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetConnectionsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  catalog_id: "CatalogIdString",
  filter: {
    match_criteria: ["NameString"],
    connection_type: "JDBC", # accepts JDBC, SFTP
  },
  hide_password: false,
  next_token: "Token",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_idString

The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by default.

Returns:

  • (String)

    The ID of the Data Catalog in which the connections reside.

#filterTypes::GetConnectionsFilter

A filter that controls which connections are returned.

Returns:

#hide_passwordBoolean

Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.

Returns:

  • (Boolean)

    Allows you to retrieve the connection metadata without returning the password.

#max_resultsInteger

The maximum number of connections to return in one response.

Returns:

  • (Integer)

    The maximum number of connections to return in one response.

#next_tokenString

A continuation token, if this is a continuation call.

Returns:

  • (String)

    A continuation token, if this is a continuation call.