amazonka-codestar-connections-2.0: Amazon CodeStar connections SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeStarConnections.Types

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

API version 2019-12-01 of the Amazon CodeStar connections SDK configuration.

Errors

_ConflictException :: AsError a => Fold a ServiceError Source #

Two conflicting operations have been made on the same resource.

_LimitExceededException :: AsError a => Fold a ServiceError Source #

Exceeded the maximum limit for connections.

_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #

Resource not found. Verify the connection resource ARN and try again.

_ResourceUnavailableException :: AsError a => Fold a ServiceError Source #

Resource not found. Verify the ARN for the host resource and try again.

_UnsupportedOperationException :: AsError a => Fold a ServiceError Source #

The operation is not supported. Check the connection status and try again.

ConnectionStatus

newtype ConnectionStatus Source #

Instances

Instances details
FromJSON ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

FromJSONKey ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

ToJSON ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

ToJSONKey ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

ToByteString ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

ToHeader ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

ToLog ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

ToQuery ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

FromText ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

ToText ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

FromXML ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

ToXML ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

Generic ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

Associated Types

type Rep ConnectionStatus :: Type -> Type #

Read ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

Show ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

NFData ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

Methods

rnf :: ConnectionStatus -> () #

Eq ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

Ord ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

Hashable ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

type Rep ConnectionStatus Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ConnectionStatus

type Rep ConnectionStatus = D1 ('MetaData "ConnectionStatus" "Amazonka.CodeStarConnections.Types.ConnectionStatus" "amazonka-codestar-connections-2.0-JfXvFjuvjBh3smH2VU30JL" 'True) (C1 ('MetaCons "ConnectionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConnectionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ProviderType

newtype ProviderType Source #

Constructors

ProviderType' 

Instances

Instances details
FromJSON ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

FromJSONKey ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

ToJSON ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

ToJSONKey ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

ToByteString ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

ToHeader ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

ToLog ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

ToQuery ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

FromText ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

ToText ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

Methods

toText :: ProviderType -> Text #

FromXML ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

ToXML ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

Methods

toXML :: ProviderType -> XML #

Generic ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

Associated Types

type Rep ProviderType :: Type -> Type #

Read ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

Show ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

NFData ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

Methods

rnf :: ProviderType -> () #

Eq ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

Ord ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

Hashable ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

type Rep ProviderType Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.ProviderType

type Rep ProviderType = D1 ('MetaData "ProviderType" "Amazonka.CodeStarConnections.Types.ProviderType" "amazonka-codestar-connections-2.0-JfXvFjuvjBh3smH2VU30JL" 'True) (C1 ('MetaCons "ProviderType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromProviderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Connection

data Connection Source #

A resource that is used to connect third-party source providers with services like AWS CodePipeline.

Note: A connection created through CloudFormation, the CLI, or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by updating the connection in the console.

See: newConnection smart constructor.

Constructors

Connection' 

Fields

  • connectionArn :: Maybe Text

    The Amazon Resource Name (ARN) of the connection. 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.

  • connectionName :: Maybe Text

    The name of the connection. Connection names must be unique in an AWS user account.

  • connectionStatus :: Maybe ConnectionStatus

    The current status of the connection.

  • hostArn :: Maybe Text

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

  • ownerAccountId :: Maybe Text

    The identifier of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.

  • providerType :: Maybe ProviderType

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

Instances

Instances details
FromJSON Connection Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Connection

Generic Connection Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Connection

Associated Types

type Rep Connection :: Type -> Type #

Read Connection Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Connection

Show Connection Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Connection

NFData Connection Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Connection

Methods

rnf :: Connection -> () #

Eq Connection Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Connection

Hashable Connection Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Connection

type Rep Connection Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Connection

type Rep Connection = D1 ('MetaData "Connection" "Amazonka.CodeStarConnections.Types.Connection" "amazonka-codestar-connections-2.0-JfXvFjuvjBh3smH2VU30JL" 'False) (C1 ('MetaCons "Connection'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "connectionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "connectionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "connectionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionStatus)))) :*: (S1 ('MetaSel ('Just "hostArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "ownerAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "providerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProviderType))))))

newConnection :: Connection Source #

Create a value of Connection 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:connectionArn:Connection', connection_connectionArn - The Amazon Resource Name (ARN) of the connection. 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.

$sel:connectionName:Connection', connection_connectionName - The name of the connection. Connection names must be unique in an AWS user account.

$sel:connectionStatus:Connection', connection_connectionStatus - The current status of the connection.

$sel:hostArn:Connection', connection_hostArn - The Amazon Resource Name (ARN) of the host associated with the connection.

$sel:ownerAccountId:Connection', connection_ownerAccountId - The identifier of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.

$sel:providerType:Connection', connection_providerType - The name of the external provider where your third-party code repository is configured.

connection_connectionArn :: Lens' Connection (Maybe Text) Source #

The Amazon Resource Name (ARN) of the connection. 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.

connection_connectionName :: Lens' Connection (Maybe Text) Source #

The name of the connection. Connection names must be unique in an AWS user account.

connection_connectionStatus :: Lens' Connection (Maybe ConnectionStatus) Source #

The current status of the connection.

connection_hostArn :: Lens' Connection (Maybe Text) Source #

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

connection_ownerAccountId :: Lens' Connection (Maybe Text) Source #

The identifier of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.

connection_providerType :: Lens' Connection (Maybe ProviderType) Source #

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

Host

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

Instances

Instances details
FromJSON Host Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.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

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

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.

Tag

data Tag Source #

A tag is a key-value pair that is used to manage the resource.

This tag is available for use by AWS services that support tags.

See: newTag smart constructor.

Constructors

Tag' 

Fields

Instances

Instances details
FromJSON Tag Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Tag

ToJSON Tag Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Tag

Generic Tag Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Tag

Associated Types

type Rep Tag :: Type -> Type #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

Read Tag Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Tag

Show Tag Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

NFData Tag Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Tag

Methods

rnf :: Tag -> () #

Eq Tag Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Tag

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

Hashable Tag Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

type Rep Tag Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.Tag

type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CodeStarConnections.Types.Tag" "amazonka-codestar-connections-2.0-JfXvFjuvjBh3smH2VU30JL" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTag Source #

Create a value of Tag 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:key:Tag', tag_key - The tag's key.

$sel:value:Tag', tag_value - The tag's value.

tag_key :: Lens' Tag Text Source #

The tag's key.

tag_value :: Lens' Tag Text Source #

The tag's value.

VpcConfiguration

data VpcConfiguration Source #

The VPC configuration provisioned for the host.

See: newVpcConfiguration smart constructor.

Constructors

VpcConfiguration' 

Fields

  • tlsCertificate :: Maybe Text

    The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

  • vpcId :: Text

    The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

  • subnetIds :: NonEmpty Text

    The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

  • securityGroupIds :: NonEmpty Text

    The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

Instances

Instances details
FromJSON VpcConfiguration Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.VpcConfiguration

ToJSON VpcConfiguration Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.VpcConfiguration

Generic VpcConfiguration Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.VpcConfiguration

Associated Types

type Rep VpcConfiguration :: Type -> Type #

Read VpcConfiguration Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.VpcConfiguration

Show VpcConfiguration Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.VpcConfiguration

NFData VpcConfiguration Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.VpcConfiguration

Methods

rnf :: VpcConfiguration -> () #

Eq VpcConfiguration Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.VpcConfiguration

Hashable VpcConfiguration Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.VpcConfiguration

type Rep VpcConfiguration Source # 
Instance details

Defined in Amazonka.CodeStarConnections.Types.VpcConfiguration

type Rep VpcConfiguration = D1 ('MetaData "VpcConfiguration" "Amazonka.CodeStarConnections.Types.VpcConfiguration" "amazonka-codestar-connections-2.0-JfXvFjuvjBh3smH2VU30JL" 'False) (C1 ('MetaCons "VpcConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tlsCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))))

newVpcConfiguration Source #

Create a value of VpcConfiguration 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:tlsCertificate:VpcConfiguration', vpcConfiguration_tlsCertificate - The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

$sel:vpcId:VpcConfiguration', vpcConfiguration_vpcId - The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

$sel:subnetIds:VpcConfiguration', vpcConfiguration_subnetIds - The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

$sel:securityGroupIds:VpcConfiguration', vpcConfiguration_securityGroupIds - The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

vpcConfiguration_tlsCertificate :: Lens' VpcConfiguration (Maybe Text) Source #

The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

vpcConfiguration_vpcId :: Lens' VpcConfiguration Text Source #

The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

vpcConfiguration_subnetIds :: Lens' VpcConfiguration (NonEmpty Text) Source #

The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

vpcConfiguration_securityGroupIds :: Lens' VpcConfiguration (NonEmpty Text) Source #

The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.