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

Class: Aws::Glue::Types::GetConnectionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

Note:

When making an API call, you may pass GetConnectionRequest data as a hash:

{
  catalog_id: "CatalogIdString",
  name: "NameString", # required
  hide_password: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_idString

The ID of the Data Catalog in which the connection resides. If none is supplied, the AWS account ID is used by default.

Returns:

  • (String)


3306
3307
3308
3309
3310
3311
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3306

class GetConnectionRequest < Struct.new(
  :catalog_id,
  :name,
  :hide_password)
  include Aws::Structure
end

#hide_passwordBoolean

Allow you to retrieve the connection metadata without displaying the password. For instance, the AWS Glue console uses this flag to retrieve connections, since the console does not display passwords. Set this parameter where the caller may not have permission to use the KMS key to decrypt the password, but does have permission to access the rest of the connection metadata (that is, the other connection properties).

Returns:

  • (Boolean)


3306
3307
3308
3309
3310
3311
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3306

class GetConnectionRequest < Struct.new(
  :catalog_id,
  :name,
  :hide_password)
  include Aws::Structure
end

#nameString

The name of the connection definition to retrieve.

Returns:

  • (String)


3306
3307
3308
3309
3310
3311
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3306

class GetConnectionRequest < Struct.new(
  :catalog_id,
  :name,
  :hide_password)
  include Aws::Structure
end