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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Create an App Runner service. After the service is created, the action also automatically starts a deployment.

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

Synopsis

Creating a Request

data CreateService Source #

See: newCreateService smart constructor.

Constructors

CreateService'

Fields

autoScalingConfigurationArn :: Maybe Text
The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration.
Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3
Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability
encryptionConfiguration :: Maybe EncryptionConfiguration
An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses an Amazon Web Services managed key.
healthCheckConfiguration :: Maybe HealthCheckConfiguration
The settings for the health check that App Runner performs to monitor the health of the App Runner service.
instanceConfiguration :: Maybe InstanceConfiguration
The runtime configuration of instances (scaling units) of your service.
networkConfiguration :: Maybe NetworkConfiguration
Configuration settings related to network traffic of the web application that the App Runner service runs.
observabilityConfiguration :: Maybe ServiceObservabilityConfiguration
The observability configuration of your service.
tags :: Maybe [Tag]
An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.
serviceName :: Text
A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.
sourceConfiguration :: SourceConfiguration
The source to deploy to the App Runner service. It can be a code or an image repository.

Instances

Instances details

ToJSON CreateService Source #
Instance details Defined in Amazonka.AppRunner.CreateService Methods toJSON :: CreateService -> Value # toEncoding :: CreateService -> Encoding # toJSONList :: [CreateService] -> Value # toEncodingList :: [CreateService] -> Encoding #
ToHeaders CreateService Source #
Instance details Defined in Amazonka.AppRunner.CreateService Methods toHeaders :: CreateService -> [Header] #
ToPath CreateService Source #
Instance details Defined in Amazonka.AppRunner.CreateService Methods toPath :: CreateService -> ByteString #
ToQuery CreateService Source #
Instance details Defined in Amazonka.AppRunner.CreateService Methods toQuery :: CreateService -> QueryString #
AWSRequest CreateService Source #
Instance details Defined in Amazonka.AppRunner.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.AppRunner.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.AppRunner.CreateService Methods showsPrec :: Int -> CreateService -> ShowS # show :: CreateService -> String # showList :: [CreateService] -> ShowS #
NFData CreateService Source #
Instance details Defined in Amazonka.AppRunner.CreateService Methods rnf :: CreateService -> () #
Eq CreateService Source #
Instance details Defined in Amazonka.AppRunner.CreateService Methods (==) :: CreateService -> CreateService -> Bool # (/=) :: CreateService -> CreateService -> Bool #
Hashable CreateService Source #
Instance details Defined in Amazonka.AppRunner.CreateService Methods hashWithSalt :: Int -> CreateService -> Int # hash :: CreateService -> Int #
type AWSResponse CreateService Source #
Instance details Defined in Amazonka.AppRunner.CreateService type AWSResponse CreateService = CreateServiceResponse
type Rep CreateService Source #
Instance details Defined in Amazonka.AppRunner.CreateService type Rep CreateService = D1 ('MetaData "CreateService" "Amazonka.AppRunner.CreateService" "amazonka-apprunner-2.0-EwwUWnxXZrM2Mgbv25gcO5" 'False) (C1 ('MetaCons "CreateService'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "autoScalingConfigurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfiguration))) :: (S1 ('MetaSel ('Just "healthCheckConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthCheckConfiguration)) :: S1 ('MetaSel ('Just "instanceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceConfiguration)))) :: ((S1 ('MetaSel ('Just "networkConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkConfiguration)) :: S1 ('MetaSel ('Just "observabilityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceObservabilityConfiguration))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sourceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SourceConfiguration))))))

newCreateService Source #

Arguments

:: Text	`CreateService`
-> SourceConfiguration	`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_autoScalingConfigurationArn - The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration.

Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3

Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability

CreateService, createService_encryptionConfiguration - An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses an Amazon Web Services managed key.

CreateService, createService_healthCheckConfiguration - The settings for the health check that App Runner performs to monitor the health of the App Runner service.

CreateService, createService_instanceConfiguration - The runtime configuration of instances (scaling units) of your service.

CreateService, createService_networkConfiguration - Configuration settings related to network traffic of the web application that the App Runner service runs.

CreateService, createService_observabilityConfiguration - The observability configuration of your service.

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

CreateService, createService_serviceName - A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.

CreateService, createService_sourceConfiguration - The source to deploy to the App Runner service. It can be a code or an image repository.

Request Lenses

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

The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration.

Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3

Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability

createService_encryptionConfiguration :: Lens' CreateService (Maybe EncryptionConfiguration) Source #

An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses an Amazon Web Services managed key.

createService_healthCheckConfiguration :: Lens' CreateService (Maybe HealthCheckConfiguration) Source #

The settings for the health check that App Runner performs to monitor the health of the App Runner service.

createService_instanceConfiguration :: Lens' CreateService (Maybe InstanceConfiguration) Source #

The runtime configuration of instances (scaling units) of your service.

createService_networkConfiguration :: Lens' CreateService (Maybe NetworkConfiguration) Source #

Configuration settings related to network traffic of the web application that the App Runner service runs.

createService_observabilityConfiguration :: Lens' CreateService (Maybe ServiceObservabilityConfiguration) Source #

The observability configuration of your service.

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

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

createService_serviceName :: Lens' CreateService Text Source #

A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.

createService_sourceConfiguration :: Lens' CreateService SourceConfiguration Source #

The source to deploy to the App Runner service. It can be a code or an image repository.

Destructuring the Response

data CreateServiceResponse Source #

See: newCreateServiceResponse smart constructor.

Constructors

CreateServiceResponse'
Fields httpStatus :: Int The response's http status code. service :: Service A description of the App Runner service that's created by this request. operationId :: Text The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.

Instances

Instances details

Generic CreateServiceResponse Source #
Instance details Defined in Amazonka.AppRunner.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.AppRunner.CreateService Methods showsPrec :: Int -> CreateServiceResponse -> ShowS # show :: CreateServiceResponse -> String # showList :: [CreateServiceResponse] -> ShowS #
NFData CreateServiceResponse Source #
Instance details Defined in Amazonka.AppRunner.CreateService Methods rnf :: CreateServiceResponse -> () #
Eq CreateServiceResponse Source #
Instance details Defined in Amazonka.AppRunner.CreateService Methods (==) :: CreateServiceResponse -> CreateServiceResponse -> Bool # (/=) :: CreateServiceResponse -> CreateServiceResponse -> Bool #
type Rep CreateServiceResponse Source #
Instance details Defined in Amazonka.AppRunner.CreateService type Rep CreateServiceResponse = D1 ('MetaData "CreateServiceResponse" "Amazonka.AppRunner.CreateService" "amazonka-apprunner-2.0-EwwUWnxXZrM2Mgbv25gcO5" 'False) (C1 ('MetaCons "CreateServiceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Service) :: S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateServiceResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateServiceResponse'`
-> Service	`$sel:service:CreateServiceResponse'`
-> Text	`$sel:operationId: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 - A description of the App Runner service that's created by this request.

$sel:operationId:CreateServiceResponse', createServiceResponse_operationId - The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.

Response Lenses

createServiceResponse_httpStatus :: Lens' CreateServiceResponse Int Source #

The response's http status code.

createServiceResponse_service :: Lens' CreateServiceResponse Service Source #

A description of the App Runner service that's created by this request.

createServiceResponse_operationId :: Lens' CreateServiceResponse Text Source #

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.