AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::CodeStarconnections::Types::Host

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

Overview

A resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider.

A host created through the CLI or the SDK is in PENDING status by default. You can make its status AVAILABLE by setting up the host in the console.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#host_arnString

The Amazon Resource Name (ARN) of the host.

Returns:

  • (String)


405
406
407
408
409
410
411
412
413
414
415
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/types.rb', line 405

class Host < Struct.new(
  :name,
  :host_arn,
  :provider_type,
  :provider_endpoint,
  :vpc_configuration,
  :status,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the host.

Returns:

  • (String)


405
406
407
408
409
410
411
412
413
414
415
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/types.rb', line 405

class Host < Struct.new(
  :name,
  :host_arn,
  :provider_type,
  :provider_endpoint,
  :vpc_configuration,
  :status,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#provider_endpointString

The endpoint of the infrastructure where your provider type is installed.

Returns:

  • (String)


405
406
407
408
409
410
411
412
413
414
415
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/types.rb', line 405

class Host < Struct.new(
  :name,
  :host_arn,
  :provider_type,
  :provider_endpoint,
  :vpc_configuration,
  :status,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#provider_typeString

The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.

Returns:

  • (String)


405
406
407
408
409
410
411
412
413
414
415
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/types.rb', line 405

class Host < Struct.new(
  :name,
  :host_arn,
  :provider_type,
  :provider_endpoint,
  :vpc_configuration,
  :status,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

Returns:

  • (String)


405
406
407
408
409
410
411
412
413
414
415
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/types.rb', line 405

class Host < Struct.new(
  :name,
  :host_arn,
  :provider_type,
  :provider_endpoint,
  :vpc_configuration,
  :status,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#status_messageString

The status description for the host.

Returns:

  • (String)


405
406
407
408
409
410
411
412
413
414
415
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/types.rb', line 405

class Host < Struct.new(
  :name,
  :host_arn,
  :provider_type,
  :provider_endpoint,
  :vpc_configuration,
  :status,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configurationTypes::VpcConfiguration

The VPC configuration provisioned for the host.



405
406
407
408
409
410
411
412
413
414
415
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/types.rb', line 405

class Host < Struct.new(
  :name,
  :host_arn,
  :provider_type,
  :provider_endpoint,
  :vpc_configuration,
  :status,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end