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.Proton.CreateService

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the Proton User Guide.

Synopsis

data CreateService = CreateService' {
- branchName :: Maybe Text
- description :: Maybe (Sensitive Text)
- repositoryConnectionArn :: Maybe Text
- repositoryId :: Maybe Text
- tags :: Maybe [Tag]
- templateMinorVersion :: Maybe Text
- name :: Text
- spec :: Sensitive Text
- templateMajorVersion :: Text
- templateName :: Text
}
newCreateService :: Text -> Text -> Text -> Text -> CreateService
createService_branchName :: Lens' CreateService (Maybe Text)
createService_description :: Lens' CreateService (Maybe Text)
createService_repositoryConnectionArn :: Lens' CreateService (Maybe Text)
createService_repositoryId :: Lens' CreateService (Maybe Text)
createService_tags :: Lens' CreateService (Maybe [Tag])
createService_templateMinorVersion :: Lens' CreateService (Maybe Text)
createService_name :: Lens' CreateService Text
createService_spec :: Lens' CreateService Text
createService_templateMajorVersion :: Lens' CreateService Text
createService_templateName :: Lens' CreateService Text
data CreateServiceResponse = CreateServiceResponse' {
- httpStatus :: Int
- service :: Service
}
newCreateServiceResponse :: Int -> Service -> CreateServiceResponse
createServiceResponse_httpStatus :: Lens' CreateServiceResponse Int
createServiceResponse_service :: Lens' CreateServiceResponse Service

Creating a Request

data CreateService Source #

See: newCreateService smart constructor.

Constructors

CreateService'

Fields

branchName :: Maybe Text
The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if your service template doesn't include a service pipeline.
description :: Maybe (Sensitive Text)
A description of the Proton service.
repositoryConnectionArn :: Maybe Text
The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.
repositoryId :: Maybe Text
The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.
tags :: Maybe [Tag]
An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
templateMinorVersion :: Maybe Text
The minor version of the service template that was used to create the service.
name :: Text
The service name.
spec :: Sensitive Text
A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton User Guide.
templateMajorVersion :: Text
The major version of the service template that was used to create the service.
templateName :: Text
The name of the service template that's used to create the service.

Instances

Instances details

ToJSON CreateService Source #
Instance details Defined in Amazonka.Proton.CreateService Methods toJSON :: CreateService -> Value # toEncoding :: CreateService -> Encoding # toJSONList :: [CreateService] -> Value # toEncodingList :: [CreateService] -> Encoding #
ToHeaders CreateService Source #
Instance details Defined in Amazonka.Proton.CreateService Methods toHeaders :: CreateService -> [Header] #
ToPath CreateService Source #
Instance details Defined in Amazonka.Proton.CreateService Methods toPath :: CreateService -> ByteString #
ToQuery CreateService Source #
Instance details Defined in Amazonka.Proton.CreateService Methods toQuery :: CreateService -> QueryString #
AWSRequest CreateService Source #
Instance details Defined in Amazonka.Proton.CreateService Associated Types type AWSResponse CreateService # Methods request :: (Service -> Service) -> CreateService -> Request CreateService # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateService -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateService))) #
Generic CreateService Source #
Instance details Defined in Amazonka.Proton.CreateService Associated Types type Rep CreateService :: Type -> Type # Methods from :: CreateService -> Rep CreateService x # to :: Rep CreateService x -> CreateService #
Show CreateService Source #
Instance details Defined in Amazonka.Proton.CreateService Methods showsPrec :: Int -> CreateService -> ShowS # show :: CreateService -> String # showList :: [CreateService] -> ShowS #
NFData CreateService Source #
Instance details Defined in Amazonka.Proton.CreateService Methods rnf :: CreateService -> () #
Eq CreateService Source #
Instance details Defined in Amazonka.Proton.CreateService Methods (==) :: CreateService -> CreateService -> Bool # (/=) :: CreateService -> CreateService -> Bool #
Hashable CreateService Source #
Instance details Defined in Amazonka.Proton.CreateService Methods hashWithSalt :: Int -> CreateService -> Int # hash :: CreateService -> Int #
type AWSResponse CreateService Source #
Instance details Defined in Amazonka.Proton.CreateService type AWSResponse CreateService = CreateServiceResponse
type Rep CreateService Source #
Instance details Defined in Amazonka.Proton.CreateService type Rep CreateService = D1 ('MetaData "CreateService" "Amazonka.Proton.CreateService" "amazonka-proton-2.0-LlJ92rKPVfGGXHsLqGeI74" 'False) (C1 ('MetaCons "CreateService'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "branchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "repositoryConnectionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "repositoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))))) :: ((S1 ('MetaSel ('Just "templateMinorVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "spec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :: (S1 ('MetaSel ('Just "templateMajorVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateService Source #

Arguments

:: Text	`CreateService`
-> Text	`CreateService`
-> Text	`CreateService`
-> Text	`CreateService`
-> CreateService

Create a value of CreateService 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:

CreateService, createService_branchName - The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if your service template doesn't include a service pipeline.

CreateService, createService_description - A description of the Proton service.

CreateService, createService_repositoryConnectionArn - The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.

CreateService, createService_repositoryId - The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.

$sel:tags:CreateService', createService_tags - An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

CreateService, createService_templateMinorVersion - The minor version of the service template that was used to create the service.

CreateService, createService_name - The service name.

CreateService, createService_spec - A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton User Guide.

CreateService, createService_templateMajorVersion - The major version of the service template that was used to create the service.

CreateService, createService_templateName - The name of the service template that's used to create the service.

Request Lenses

createService_branchName :: Lens' CreateService (Maybe Text) Source #

The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if your service template doesn't include a service pipeline.

createService_description :: Lens' CreateService (Maybe Text) Source #

A description of the Proton service.

createService_repositoryConnectionArn :: Lens' CreateService (Maybe Text) Source #

The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.

createService_repositoryId :: Lens' CreateService (Maybe Text) Source #

The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.

createService_tags :: Lens' CreateService (Maybe [Tag]) Source #

An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

createService_templateMinorVersion :: Lens' CreateService (Maybe Text) Source #

The minor version of the service template that was used to create the service.

createService_name :: Lens' CreateService Text Source #

The service name.

createService_spec :: Lens' CreateService Text Source #

A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton User Guide.

createService_templateMajorVersion :: Lens' CreateService Text Source #

The major version of the service template that was used to create the service.

createService_templateName :: Lens' CreateService Text Source #

The name of the service template that's used to create the service.

Destructuring the Response

data CreateServiceResponse Source #

See: newCreateServiceResponse smart constructor.

Constructors

CreateServiceResponse'
Fields httpStatus :: Int The response's http status code. service :: Service The service detail data that's returned by Proton.

Instances

Instances details

Generic CreateServiceResponse Source #
Instance details Defined in Amazonka.Proton.CreateService Associated Types type Rep CreateServiceResponse :: Type -> Type # Methods from :: CreateServiceResponse -> Rep CreateServiceResponse x # to :: Rep CreateServiceResponse x -> CreateServiceResponse #
Show CreateServiceResponse Source #
Instance details Defined in Amazonka.Proton.CreateService Methods showsPrec :: Int -> CreateServiceResponse -> ShowS # show :: CreateServiceResponse -> String # showList :: [CreateServiceResponse] -> ShowS #
NFData CreateServiceResponse Source #
Instance details Defined in Amazonka.Proton.CreateService Methods rnf :: CreateServiceResponse -> () #
Eq CreateServiceResponse Source #
Instance details Defined in Amazonka.Proton.CreateService Methods (==) :: CreateServiceResponse -> CreateServiceResponse -> Bool # (/=) :: CreateServiceResponse -> CreateServiceResponse -> Bool #
type Rep CreateServiceResponse Source #
Instance details Defined in Amazonka.Proton.CreateService type Rep CreateServiceResponse = D1 ('MetaData "CreateServiceResponse" "Amazonka.Proton.CreateService" "amazonka-proton-2.0-LlJ92rKPVfGGXHsLqGeI74" 'False) (C1 ('MetaCons "CreateServiceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Service)))

newCreateServiceResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateServiceResponse'`
-> Service	`$sel:service:CreateServiceResponse'`
-> CreateServiceResponse

Create a value of CreateServiceResponse 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:httpStatus:CreateServiceResponse', createServiceResponse_httpStatus - The response's http status code.

$sel:service:CreateServiceResponse', createServiceResponse_service - The service detail data that's returned by Proton.

Response Lenses

createServiceResponse_httpStatus :: Lens' CreateServiceResponse Int Source #

The response's http status code.

createServiceResponse_service :: Lens' CreateServiceResponse Service Source #

The service detail data that's returned by Proton.