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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a connection that can then be given to other AWS services like CodePipeline so that it can access third-party code repositories. The connection is in pending status until the third-party connection handshake is completed from the console.

Synopsis

data CreateConnection = CreateConnection' {
- providerType :: Maybe ProviderType
- hostArn :: Maybe Text
- tags :: Maybe [Tag]
- connectionName :: Text
}
newCreateConnection :: Text -> CreateConnection
createConnection_providerType :: Lens' CreateConnection (Maybe ProviderType)
createConnection_hostArn :: Lens' CreateConnection (Maybe Text)
createConnection_tags :: Lens' CreateConnection (Maybe [Tag])
createConnection_connectionName :: Lens' CreateConnection Text
data CreateConnectionResponse = CreateConnectionResponse' {
- tags :: Maybe [Tag]
- httpStatus :: Int
- connectionArn :: Text
}
newCreateConnectionResponse :: Int -> Text -> CreateConnectionResponse
createConnectionResponse_tags :: Lens' CreateConnectionResponse (Maybe [Tag])
createConnectionResponse_httpStatus :: Lens' CreateConnectionResponse Int
createConnectionResponse_connectionArn :: Lens' CreateConnectionResponse Text

Creating a Request

data CreateConnection Source #

See: newCreateConnection smart constructor.

Constructors

CreateConnection'

Fields

providerType :: Maybe ProviderType
The name of the external provider where your third-party code repository is configured.
hostArn :: Maybe Text
The Amazon Resource Name (ARN) of the host associated with the connection to be created.
tags :: Maybe [Tag]
The key-value pair to use when tagging the resource.
connectionName :: Text
The name of the connection to be created. The name must be unique in the calling AWS account.

Instances

Instances details

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

newCreateConnection Source #

Arguments

:: Text	`$sel:connectionName:CreateConnection'`
-> CreateConnection

Create a value of CreateConnection 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:providerType:CreateConnection', createConnection_providerType - The name of the external provider where your third-party code repository is configured.

$sel:hostArn:CreateConnection', createConnection_hostArn - The Amazon Resource Name (ARN) of the host associated with the connection to be created.

$sel:tags:CreateConnection', createConnection_tags - The key-value pair to use when tagging the resource.

$sel:connectionName:CreateConnection', createConnection_connectionName - The name of the connection to be created. The name must be unique in the calling AWS account.

Request Lenses

createConnection_providerType :: Lens' CreateConnection (Maybe ProviderType) Source #

The name of the external provider where your third-party code repository is configured.

createConnection_hostArn :: Lens' CreateConnection (Maybe Text) Source #

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

createConnection_tags :: Lens' CreateConnection (Maybe [Tag]) Source #

The key-value pair to use when tagging the resource.

createConnection_connectionName :: Lens' CreateConnection Text Source #

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

Destructuring the Response

data CreateConnectionResponse Source #

See: newCreateConnectionResponse smart constructor.

Constructors

CreateConnectionResponse'
Fields tags :: Maybe [Tag] Specifies the tags applied to the resource. httpStatus :: Int The response's http status code. connectionArn :: Text The Amazon Resource Name (ARN) of the connection to be created. The ARN is used as the connection reference when the connection is shared between AWS services. The ARN is never reused if the connection is deleted.

Instances

Instances details

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

newCreateConnectionResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateConnectionResponse'`
-> Text	`$sel:connectionArn:CreateConnectionResponse'`
-> CreateConnectionResponse

Create a value of CreateConnectionResponse 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:tags:CreateConnection', createConnectionResponse_tags - Specifies the tags applied to the resource.

$sel:httpStatus:CreateConnectionResponse', createConnectionResponse_httpStatus - The response's http status code.

$sel:connectionArn:CreateConnectionResponse', createConnectionResponse_connectionArn - The Amazon Resource Name (ARN) of the connection to be created. The ARN is used as the connection reference when the connection is shared between AWS services.

The ARN is never reused if the connection is deleted.

Response Lenses

createConnectionResponse_tags :: Lens' CreateConnectionResponse (Maybe [Tag]) Source #

Specifies the tags applied to the resource.

createConnectionResponse_httpStatus :: Lens' CreateConnectionResponse Int Source #

The response's http status code.

createConnectionResponse_connectionArn :: Lens' CreateConnectionResponse Text Source #

The Amazon Resource Name (ARN) of the connection to be created. The ARN is used as the connection reference when the connection is shared between AWS services.

The ARN is never reused if the connection is deleted.