Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeStarConnections.CreateHost

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data CreateHost = CreateHost' {
- vpcConfiguration :: Maybe VpcConfiguration
- tags :: Maybe [Tag]
- name :: Text
- providerType :: ProviderType
- providerEndpoint :: Text
}
newCreateHost :: Text -> ProviderType -> Text -> CreateHost
createHost_vpcConfiguration :: Lens' CreateHost (Maybe VpcConfiguration)
createHost_tags :: Lens' CreateHost (Maybe [Tag])
createHost_name :: Lens' CreateHost Text
createHost_providerType :: Lens' CreateHost ProviderType
createHost_providerEndpoint :: Lens' CreateHost Text
data CreateHostResponse = CreateHostResponse' {
- hostArn :: Maybe Text
- tags :: Maybe [Tag]
- httpStatus :: Int
}
newCreateHostResponse :: Int -> CreateHostResponse
createHostResponse_hostArn :: Lens' CreateHostResponse (Maybe Text)
createHostResponse_tags :: Lens' CreateHostResponse (Maybe [Tag])
createHostResponse_httpStatus :: Lens' CreateHostResponse Int

Creating a Request

data CreateHost Source #

See: newCreateHost smart constructor.

Constructors

CreateHost'

Fields

vpcConfiguration :: Maybe VpcConfiguration
The VPC configuration to be provisioned for the host. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.
tags :: Maybe [Tag]
name :: Text
The name of the host to be created. The name must be unique in the calling AWS account.
providerType :: 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.
providerEndpoint :: Text
The endpoint of the infrastructure to be represented by the host after it is created.

Instances

Instances details

Eq CreateHost Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Methods (==) :: CreateHost -> CreateHost -> Bool # (/=) :: CreateHost -> CreateHost -> Bool #
Read CreateHost Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Methods readsPrec :: Int -> ReadS CreateHost # readList :: ReadS [CreateHost] # readPrec :: ReadPrec CreateHost # readListPrec :: ReadPrec [CreateHost] #
Show CreateHost Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Methods showsPrec :: Int -> CreateHost -> ShowS # show :: CreateHost -> String # showList :: [CreateHost] -> ShowS #
Generic CreateHost Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Associated Types type Rep CreateHost :: Type -> Type # Methods from :: CreateHost -> Rep CreateHost x # to :: Rep CreateHost x -> CreateHost #
NFData CreateHost Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Methods rnf :: CreateHost -> () #
Hashable CreateHost Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Methods hashWithSalt :: Int -> CreateHost -> Int # hash :: CreateHost -> Int #
ToJSON CreateHost Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Methods toJSON :: CreateHost -> Value # toEncoding :: CreateHost -> Encoding # toJSONList :: [CreateHost] -> Value # toEncodingList :: [CreateHost] -> Encoding #
AWSRequest CreateHost Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Associated Types type AWSResponse CreateHost # Methods request :: CreateHost -> Request CreateHost # response :: MonadResource m => Logger -> Service -> Proxy CreateHost -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateHost))) #
ToHeaders CreateHost Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Methods toHeaders :: CreateHost -> [Header] #
ToPath CreateHost Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Methods toPath :: CreateHost -> ByteString #
ToQuery CreateHost Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Methods toQuery :: CreateHost -> QueryString #
type Rep CreateHost Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost type Rep CreateHost = D1 ('MetaData "CreateHost" "Amazonka.CodeStarConnections.CreateHost" "libZSservicesZSamazonka-codestar-connectionsZSamazonka-codestar-connections" 'False) (C1 ('MetaCons "CreateHost'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfiguration)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "providerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProviderType) :: S1 ('MetaSel ('Just "providerEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateHost Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost type AWSResponse CreateHost = CreateHostResponse

newCreateHost Source #

Arguments

:: Text	`$sel:name:CreateHost'`
-> ProviderType	`$sel:providerType:CreateHost'`
-> Text	`$sel:providerEndpoint:CreateHost'`
-> CreateHost

Create a value of CreateHost 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:vpcConfiguration:CreateHost', createHost_vpcConfiguration - The VPC configuration to be provisioned for the host. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.

$sel:tags:CreateHost', createHost_tags - Undocumented member.

$sel:name:CreateHost', createHost_name - The name of the host to be created. The name must be unique in the calling AWS account.

$sel:providerType:CreateHost', createHost_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:providerEndpoint:CreateHost', createHost_providerEndpoint - The endpoint of the infrastructure to be represented by the host after it is created.

Request Lenses

createHost_vpcConfiguration :: Lens' CreateHost (Maybe VpcConfiguration) Source #

The VPC configuration to be provisioned for the host. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.

createHost_tags :: Lens' CreateHost (Maybe [Tag]) Source #

Undocumented member.

createHost_name :: Lens' CreateHost Text Source #

The name of the host to be created. The name must be unique in the calling AWS account.

createHost_providerType :: Lens' CreateHost 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.

createHost_providerEndpoint :: Lens' CreateHost Text Source #

The endpoint of the infrastructure to be represented by the host after it is created.

Destructuring the Response

data CreateHostResponse Source #

See: newCreateHostResponse smart constructor.

Constructors

CreateHostResponse'
Fields hostArn :: Maybe Text The Amazon Resource Name (ARN) of the host to be created. tags :: Maybe [Tag] httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateHostResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Methods (==) :: CreateHostResponse -> CreateHostResponse -> Bool # (/=) :: CreateHostResponse -> CreateHostResponse -> Bool #
Read CreateHostResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Methods readsPrec :: Int -> ReadS CreateHostResponse # readList :: ReadS [CreateHostResponse] # readPrec :: ReadPrec CreateHostResponse # readListPrec :: ReadPrec [CreateHostResponse] #
Show CreateHostResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Methods showsPrec :: Int -> CreateHostResponse -> ShowS # show :: CreateHostResponse -> String # showList :: [CreateHostResponse] -> ShowS #
Generic CreateHostResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Associated Types type Rep CreateHostResponse :: Type -> Type # Methods from :: CreateHostResponse -> Rep CreateHostResponse x # to :: Rep CreateHostResponse x -> CreateHostResponse #
NFData CreateHostResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost Methods rnf :: CreateHostResponse -> () #
type Rep CreateHostResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.CreateHost type Rep CreateHostResponse = D1 ('MetaData "CreateHostResponse" "Amazonka.CodeStarConnections.CreateHost" "libZSservicesZSamazonka-codestar-connectionsZSamazonka-codestar-connections" 'False) (C1 ('MetaCons "CreateHostResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateHostResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateHostResponse'`
-> CreateHostResponse

Create a value of CreateHostResponse 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:CreateHostResponse', createHostResponse_hostArn - The Amazon Resource Name (ARN) of the host to be created.

$sel:tags:CreateHost', createHostResponse_tags - Undocumented member.

$sel:httpStatus:CreateHostResponse', createHostResponse_httpStatus - The response's http status code.

Response Lenses

createHostResponse_hostArn :: Lens' CreateHostResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the host to be created.

createHostResponse_tags :: Lens' CreateHostResponse (Maybe [Tag]) Source #

Undocumented member.

createHostResponse_httpStatus :: Lens' CreateHostResponse Int Source #

The response's http status code.