Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CodeStarConnections.Types.Host

Description

Synopsis

data Host = Host' {
- hostArn :: Maybe Text
- name :: Maybe Text
- providerEndpoint :: Maybe Text
- providerType :: Maybe ProviderType
- status :: Maybe Text
- statusMessage :: Maybe Text
- vpcConfiguration :: Maybe VpcConfiguration
}
newHost :: Host
host_hostArn :: Lens' Host (Maybe Text)
host_name :: Lens' Host (Maybe Text)
host_providerEndpoint :: Lens' Host (Maybe Text)
host_providerType :: Lens' Host (Maybe ProviderType)
host_status :: Lens' Host (Maybe Text)
host_statusMessage :: Lens' Host (Maybe Text)
host_vpcConfiguration :: Lens' Host (Maybe VpcConfiguration)

Documentation

data Host Source #

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: newHost smart constructor.

Constructors

Host'

Fields

hostArn :: Maybe Text
The Amazon Resource Name (ARN) of the host.
name :: Maybe Text
The name of the host.
providerEndpoint :: Maybe Text
The endpoint of the infrastructure where your provider type is installed.
providerType :: Maybe ProviderType
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.
status :: Maybe Text
The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.
statusMessage :: Maybe Text
The status description for the host.
vpcConfiguration :: Maybe VpcConfiguration
The VPC configuration provisioned for the host.

Instances

Instances details

FromJSON Host Source #
Instance details Defined in Amazonka.CodeStarConnections.Types.Host Methods parseJSON :: Value -> Parser Host # parseJSONList :: Value -> Parser [Host] #
Generic Host Source #
Instance details Defined in Amazonka.CodeStarConnections.Types.Host Associated Types type Rep Host :: Type -> Type # Methods from :: Host -> Rep Host x # to :: Rep Host x -> Host #
Read Host Source #
Instance details Defined in Amazonka.CodeStarConnections.Types.Host Methods readsPrec :: Int -> ReadS Host # readList :: ReadS [Host] # readPrec :: ReadPrec Host # readListPrec :: ReadPrec [Host] #
Show Host Source #
Instance details Defined in Amazonka.CodeStarConnections.Types.Host Methods showsPrec :: Int -> Host -> ShowS # show :: Host -> String # showList :: [Host] -> ShowS #
NFData Host Source #
Instance details Defined in Amazonka.CodeStarConnections.Types.Host Methods rnf :: Host -> () #
Eq Host Source #
Instance details Defined in Amazonka.CodeStarConnections.Types.Host Methods (==) :: Host -> Host -> Bool # (/=) :: Host -> Host -> Bool #
Hashable Host Source #
Instance details Defined in Amazonka.CodeStarConnections.Types.Host Methods hashWithSalt :: Int -> Host -> Int # hash :: Host -> Int #
type Rep Host Source #
Instance details Defined in Amazonka.CodeStarConnections.Types.Host type Rep Host = D1 ('MetaData "Host" "Amazonka.CodeStarConnections.Types.Host" "amazonka-codestar-connections-2.0-JfXvFjuvjBh3smH2VU30JL" 'False) (C1 ('MetaCons "Host'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hostArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "providerEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "providerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProviderType)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfiguration))))))

newHost :: Host Source #

Create a value of Host with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:hostArn:Host', host_hostArn - The Amazon Resource Name (ARN) of the host.

$sel:name:Host', host_name - The name of the host.

$sel:providerEndpoint:Host', host_providerEndpoint - The endpoint of the infrastructure where your provider type is installed.

$sel:providerType:Host', host_providerType - 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.

$sel:status:Host', host_status - The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

$sel:statusMessage:Host', host_statusMessage - The status description for the host.

$sel:vpcConfiguration:Host', host_vpcConfiguration - The VPC configuration provisioned for the host.

host_hostArn :: Lens' Host (Maybe Text) Source #

The Amazon Resource Name (ARN) of the host.

host_name :: Lens' Host (Maybe Text) Source #

The name of the host.

host_providerEndpoint :: Lens' Host (Maybe Text) Source #

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

host_providerType :: Lens' Host (Maybe ProviderType) Source #

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.

host_status :: Lens' Host (Maybe Text) Source #

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

host_statusMessage :: Lens' Host (Maybe Text) Source #

The status description for the host.

host_vpcConfiguration :: Lens' Host (Maybe VpcConfiguration) Source #

The VPC configuration provisioned for the host.