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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

<note markdown=“1”> 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.

</note>

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#host_arn ⇒ String

The Amazon Resource Name (ARN) of the host.

Returns:

  • (String) 


704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/aws-sdk-codestarconnections/types.rb', line 704

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

#name ⇒ String

The name of the host.

Returns:

  • (String) 


704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/aws-sdk-codestarconnections/types.rb', line 704

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

#provider_endpoint ⇒ String

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

Returns:

  • (String) 


704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/aws-sdk-codestarconnections/types.rb', line 704

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

#provider_type ⇒ String

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) 


704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/aws-sdk-codestarconnections/types.rb', line 704

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

#status ⇒ String

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

Returns:

  • (String) 


704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/aws-sdk-codestarconnections/types.rb', line 704

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

#status_message ⇒ String

The status description for the host.

Returns:

  • (String) 


704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/aws-sdk-codestarconnections/types.rb', line 704

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

#vpc_configuration ⇒ Types::VpcConfiguration

The VPC configuration provisioned for the host.

Returns:



704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/aws-sdk-codestarconnections/types.rb', line 704

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