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

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

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

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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#host_arn ⇒ String

The Amazon Resource Name (ARN) of the host.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the host.

#name ⇒ String

The name of the host.

Returns:

  • (String) —

    The name of the host.

#provider_endpoint ⇒ String

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

Returns:

  • (String) —

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

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

Possible values:

  • Bitbucket
  • GitHub
  • GitHubEnterpriseServer

Returns:

  • (String) —

    The name of the installed provider to be associated with your connection.

#status ⇒ String

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

Returns:

  • (String) —

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

#status_message ⇒ String

The status description for the host.

Returns:

  • (String) —

    The status description for the host.

#vpc_configuration ⇒ Types::VpcConfiguration

The VPC configuration provisioned for the host.

Returns: