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 provided, the AWS account ID is used by default.

Returns:

  • (String)


4827
4828
4829
4830
4831
4832
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 4827

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

#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)


4827
4828
4829
4830
4831
4832
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 4827

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

#nameString

The name of the connection definition to retrieve.

Returns:

  • (String)


4827
4828
4829
4830
4831
4832
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 4827

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