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 |
- Service Configuration
- Errors
- Waiters
- Operations
- ListServices
- ResumeService
- DeleteService
- UpdateService
- ListOperations
- AssociateCustomDomain
- ListConnections
- DeleteConnection
- DescribeAutoScalingConfiguration
- ListTagsForResource
- CreateConnection
- DescribeCustomDomains
- DescribeService
- DeleteAutoScalingConfiguration
- ListAutoScalingConfigurations
- DisassociateCustomDomain
- PauseService
- TagResource
- UntagResource
- CreateAutoScalingConfiguration
- StartDeployment
- CreateService
- Types
- AutoScalingConfigurationStatus
- CertificateValidationRecordStatus
- ConfigurationSource
- ConnectionStatus
- CustomDomainAssociationStatus
- HealthCheckProtocol
- ImageRepositoryType
- OperationStatus
- OperationType
- ProviderType
- Runtime
- ServiceStatus
- SourceCodeVersionType
- AuthenticationConfiguration
- AutoScalingConfiguration
- AutoScalingConfigurationSummary
- CertificateValidationRecord
- CodeConfiguration
- CodeConfigurationValues
- CodeRepository
- Connection
- ConnectionSummary
- CustomDomain
- EncryptionConfiguration
- HealthCheckConfiguration
- ImageConfiguration
- ImageRepository
- InstanceConfiguration
- OperationSummary
- Service
- ServiceSummary
- SourceCodeVersion
- SourceConfiguration
- Tag
Derived from API version 2020-05-15
of the AWS service descriptions, licensed under Apache 2.0.
App Runner
App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code to a running service in the Amazon Web Services Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to provision and configure Amazon Web Services resources.
App Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations, high performance, scalability, and security.
For more information about App Runner, see the App Runner Developer Guide. For release information, see the App Runner Release Notes.
To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see Tools for Amazon Web Services.
Endpoints
For a list of Region-specific endpoints that App Runner supports, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
Synopsis
- defaultService :: Service
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServiceErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError
- data ListServices = ListServices' (Maybe Text) (Maybe Natural)
- newListServices :: ListServices
- data ListServicesResponse = ListServicesResponse' (Maybe Text) Int [ServiceSummary]
- newListServicesResponse :: Int -> ListServicesResponse
- data ResumeService = ResumeService' Text
- newResumeService :: Text -> ResumeService
- data ResumeServiceResponse = ResumeServiceResponse' (Maybe Text) Int Service
- newResumeServiceResponse :: Int -> Service -> ResumeServiceResponse
- data DeleteService = DeleteService' Text
- newDeleteService :: Text -> DeleteService
- data DeleteServiceResponse = DeleteServiceResponse' Int Service Text
- newDeleteServiceResponse :: Int -> Service -> Text -> DeleteServiceResponse
- data UpdateService = UpdateService' (Maybe Text) (Maybe HealthCheckConfiguration) (Maybe SourceConfiguration) (Maybe InstanceConfiguration) Text
- newUpdateService :: Text -> UpdateService
- data UpdateServiceResponse = UpdateServiceResponse' Int Service Text
- newUpdateServiceResponse :: Int -> Service -> Text -> UpdateServiceResponse
- data ListOperations = ListOperations' (Maybe Text) (Maybe Natural) Text
- newListOperations :: Text -> ListOperations
- data ListOperationsResponse = ListOperationsResponse' (Maybe Text) (Maybe [OperationSummary]) Int
- newListOperationsResponse :: Int -> ListOperationsResponse
- data AssociateCustomDomain = AssociateCustomDomain' (Maybe Bool) Text Text
- newAssociateCustomDomain :: Text -> Text -> AssociateCustomDomain
- data AssociateCustomDomainResponse = AssociateCustomDomainResponse' Int Text Text CustomDomain
- newAssociateCustomDomainResponse :: Int -> Text -> Text -> CustomDomain -> AssociateCustomDomainResponse
- data ListConnections = ListConnections' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListConnections :: ListConnections
- data ListConnectionsResponse = ListConnectionsResponse' (Maybe Text) Int [ConnectionSummary]
- newListConnectionsResponse :: Int -> ListConnectionsResponse
- data DeleteConnection = DeleteConnection' Text
- newDeleteConnection :: Text -> DeleteConnection
- data DeleteConnectionResponse = DeleteConnectionResponse' (Maybe Connection) Int
- newDeleteConnectionResponse :: Int -> DeleteConnectionResponse
- data DescribeAutoScalingConfiguration = DescribeAutoScalingConfiguration' Text
- newDescribeAutoScalingConfiguration :: Text -> DescribeAutoScalingConfiguration
- data DescribeAutoScalingConfigurationResponse = DescribeAutoScalingConfigurationResponse' Int AutoScalingConfiguration
- newDescribeAutoScalingConfigurationResponse :: Int -> AutoScalingConfiguration -> DescribeAutoScalingConfigurationResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data CreateConnection = CreateConnection' (Maybe [Tag]) Text ProviderType
- newCreateConnection :: Text -> ProviderType -> CreateConnection
- data CreateConnectionResponse = CreateConnectionResponse' Int Connection
- newCreateConnectionResponse :: Int -> Connection -> CreateConnectionResponse
- data DescribeCustomDomains = DescribeCustomDomains' (Maybe Text) (Maybe Natural) Text
- newDescribeCustomDomains :: Text -> DescribeCustomDomains
- data DescribeCustomDomainsResponse = DescribeCustomDomainsResponse' (Maybe Text) Int Text Text [CustomDomain]
- newDescribeCustomDomainsResponse :: Int -> Text -> Text -> DescribeCustomDomainsResponse
- data DescribeService = DescribeService' Text
- newDescribeService :: Text -> DescribeService
- data DescribeServiceResponse = DescribeServiceResponse' Int Service
- newDescribeServiceResponse :: Int -> Service -> DescribeServiceResponse
- data DeleteAutoScalingConfiguration = DeleteAutoScalingConfiguration' Text
- newDeleteAutoScalingConfiguration :: Text -> DeleteAutoScalingConfiguration
- data DeleteAutoScalingConfigurationResponse = DeleteAutoScalingConfigurationResponse' Int AutoScalingConfiguration
- newDeleteAutoScalingConfigurationResponse :: Int -> AutoScalingConfiguration -> DeleteAutoScalingConfigurationResponse
- data ListAutoScalingConfigurations = ListAutoScalingConfigurations' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Natural)
- newListAutoScalingConfigurations :: ListAutoScalingConfigurations
- data ListAutoScalingConfigurationsResponse = ListAutoScalingConfigurationsResponse' (Maybe Text) Int [AutoScalingConfigurationSummary]
- newListAutoScalingConfigurationsResponse :: Int -> ListAutoScalingConfigurationsResponse
- data DisassociateCustomDomain = DisassociateCustomDomain' Text Text
- newDisassociateCustomDomain :: Text -> Text -> DisassociateCustomDomain
- data DisassociateCustomDomainResponse = DisassociateCustomDomainResponse' Int Text Text CustomDomain
- newDisassociateCustomDomainResponse :: Int -> Text -> Text -> CustomDomain -> DisassociateCustomDomainResponse
- data PauseService = PauseService' Text
- newPauseService :: Text -> PauseService
- data PauseServiceResponse = PauseServiceResponse' (Maybe Text) Int Service
- newPauseServiceResponse :: Int -> Service -> PauseServiceResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data CreateAutoScalingConfiguration = CreateAutoScalingConfiguration' (Maybe Natural) (Maybe Natural) (Maybe [Tag]) (Maybe Natural) Text
- newCreateAutoScalingConfiguration :: Text -> CreateAutoScalingConfiguration
- data CreateAutoScalingConfigurationResponse = CreateAutoScalingConfigurationResponse' Int AutoScalingConfiguration
- newCreateAutoScalingConfigurationResponse :: Int -> AutoScalingConfiguration -> CreateAutoScalingConfigurationResponse
- data StartDeployment = StartDeployment' Text
- newStartDeployment :: Text -> StartDeployment
- data StartDeploymentResponse = StartDeploymentResponse' Int Text
- newStartDeploymentResponse :: Int -> Text -> StartDeploymentResponse
- data CreateService = CreateService' (Maybe Text) (Maybe EncryptionConfiguration) (Maybe HealthCheckConfiguration) (Maybe [Tag]) (Maybe InstanceConfiguration) Text SourceConfiguration
- newCreateService :: Text -> SourceConfiguration -> CreateService
- data CreateServiceResponse = CreateServiceResponse' Int Service Text
- newCreateServiceResponse :: Int -> Service -> Text -> CreateServiceResponse
- newtype AutoScalingConfigurationStatus where
- newtype CertificateValidationRecordStatus where
- CertificateValidationRecordStatus' { }
- pattern CertificateValidationRecordStatus_FAILED :: CertificateValidationRecordStatus
- pattern CertificateValidationRecordStatus_PENDING_VALIDATION :: CertificateValidationRecordStatus
- pattern CertificateValidationRecordStatus_SUCCESS :: CertificateValidationRecordStatus
- newtype ConfigurationSource where
- newtype ConnectionStatus where
- ConnectionStatus' { }
- pattern ConnectionStatus_AVAILABLE :: ConnectionStatus
- pattern ConnectionStatus_DELETED :: ConnectionStatus
- pattern ConnectionStatus_ERROR :: ConnectionStatus
- pattern ConnectionStatus_PENDING_HANDSHAKE :: ConnectionStatus
- newtype CustomDomainAssociationStatus where
- CustomDomainAssociationStatus' { }
- pattern CustomDomainAssociationStatus_ACTIVE :: CustomDomainAssociationStatus
- pattern CustomDomainAssociationStatus_BINDING_CERTIFICATE :: CustomDomainAssociationStatus
- pattern CustomDomainAssociationStatus_CREATE_FAILED :: CustomDomainAssociationStatus
- pattern CustomDomainAssociationStatus_CREATING :: CustomDomainAssociationStatus
- pattern CustomDomainAssociationStatus_DELETE_FAILED :: CustomDomainAssociationStatus
- pattern CustomDomainAssociationStatus_DELETING :: CustomDomainAssociationStatus
- pattern CustomDomainAssociationStatus_PENDING_CERTIFICATE_DNS_VALIDATION :: CustomDomainAssociationStatus
- newtype HealthCheckProtocol where
- HealthCheckProtocol' { }
- pattern HealthCheckProtocol_HTTP :: HealthCheckProtocol
- pattern HealthCheckProtocol_TCP :: HealthCheckProtocol
- newtype ImageRepositoryType where
- newtype OperationStatus where
- OperationStatus' { }
- pattern OperationStatus_FAILED :: OperationStatus
- pattern OperationStatus_IN_PROGRESS :: OperationStatus
- pattern OperationStatus_PENDING :: OperationStatus
- pattern OperationStatus_ROLLBACK_FAILED :: OperationStatus
- pattern OperationStatus_ROLLBACK_IN_PROGRESS :: OperationStatus
- pattern OperationStatus_ROLLBACK_SUCCEEDED :: OperationStatus
- pattern OperationStatus_SUCCEEDED :: OperationStatus
- newtype OperationType where
- OperationType' { }
- pattern OperationType_CREATE_SERVICE :: OperationType
- pattern OperationType_DELETE_SERVICE :: OperationType
- pattern OperationType_PAUSE_SERVICE :: OperationType
- pattern OperationType_RESUME_SERVICE :: OperationType
- pattern OperationType_START_DEPLOYMENT :: OperationType
- newtype ProviderType where
- ProviderType' { }
- pattern ProviderType_GITHUB :: ProviderType
- newtype Runtime where
- Runtime' {
- fromRuntime :: Text
- pattern Runtime_NODEJS_12 :: Runtime
- pattern Runtime_PYTHON_3 :: Runtime
- Runtime' {
- newtype ServiceStatus where
- ServiceStatus' { }
- pattern ServiceStatus_CREATE_FAILED :: ServiceStatus
- pattern ServiceStatus_DELETED :: ServiceStatus
- pattern ServiceStatus_DELETE_FAILED :: ServiceStatus
- pattern ServiceStatus_OPERATION_IN_PROGRESS :: ServiceStatus
- pattern ServiceStatus_PAUSED :: ServiceStatus
- pattern ServiceStatus_RUNNING :: ServiceStatus
- newtype SourceCodeVersionType where
- data AuthenticationConfiguration = AuthenticationConfiguration' (Maybe Text) (Maybe Text)
- newAuthenticationConfiguration :: AuthenticationConfiguration
- data AutoScalingConfiguration = AutoScalingConfiguration' (Maybe AutoScalingConfigurationStatus) (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe POSIX) (Maybe Bool) (Maybe Int)
- newAutoScalingConfiguration :: AutoScalingConfiguration
- data AutoScalingConfigurationSummary = AutoScalingConfigurationSummary' (Maybe Text) (Maybe Int) (Maybe Text)
- newAutoScalingConfigurationSummary :: AutoScalingConfigurationSummary
- data CertificateValidationRecord = CertificateValidationRecord' (Maybe CertificateValidationRecordStatus) (Maybe Text) (Maybe Text) (Maybe Text)
- newCertificateValidationRecord :: CertificateValidationRecord
- data CodeConfiguration = CodeConfiguration' (Maybe CodeConfigurationValues) ConfigurationSource
- newCodeConfiguration :: ConfigurationSource -> CodeConfiguration
- data CodeConfigurationValues = CodeConfigurationValues' (Maybe (Sensitive Text)) (Maybe (HashMap Text (Sensitive Text))) (Maybe (Sensitive Text)) (Maybe Text) Runtime
- newCodeConfigurationValues :: Runtime -> CodeConfigurationValues
- data CodeRepository = CodeRepository' (Maybe CodeConfiguration) Text SourceCodeVersion
- newCodeRepository :: Text -> SourceCodeVersion -> CodeRepository
- data Connection = Connection' (Maybe ConnectionStatus) (Maybe POSIX) (Maybe ProviderType) (Maybe Text) (Maybe Text)
- newConnection :: Connection
- data ConnectionSummary = ConnectionSummary' (Maybe ConnectionStatus) (Maybe POSIX) (Maybe ProviderType) (Maybe Text) (Maybe Text)
- newConnectionSummary :: ConnectionSummary
- data CustomDomain = CustomDomain' (Maybe [CertificateValidationRecord]) Text Bool CustomDomainAssociationStatus
- newCustomDomain :: Text -> Bool -> CustomDomainAssociationStatus -> CustomDomain
- data EncryptionConfiguration = EncryptionConfiguration' Text
- newEncryptionConfiguration :: Text -> EncryptionConfiguration
- data HealthCheckConfiguration = HealthCheckConfiguration' (Maybe Natural) (Maybe Text) (Maybe HealthCheckProtocol) (Maybe Natural) (Maybe Natural) (Maybe Natural)
- newHealthCheckConfiguration :: HealthCheckConfiguration
- data ImageConfiguration = ImageConfiguration' (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) (Maybe Text)
- newImageConfiguration :: ImageConfiguration
- data ImageRepository = ImageRepository' (Maybe ImageConfiguration) Text ImageRepositoryType
- newImageRepository :: Text -> ImageRepositoryType -> ImageRepository
- data InstanceConfiguration = InstanceConfiguration' (Maybe Text) (Maybe Text) (Maybe Text)
- newInstanceConfiguration :: InstanceConfiguration
- data OperationSummary = OperationSummary' (Maybe OperationStatus) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe OperationType) (Maybe POSIX)
- newOperationSummary :: OperationSummary
- data Service = Service' (Maybe EncryptionConfiguration) (Maybe HealthCheckConfiguration) (Maybe POSIX) Text Text Text Text POSIX POSIX ServiceStatus SourceConfiguration InstanceConfiguration AutoScalingConfigurationSummary
- newService :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> ServiceStatus -> SourceConfiguration -> InstanceConfiguration -> AutoScalingConfigurationSummary -> Service
- data ServiceSummary = ServiceSummary' (Maybe ServiceStatus) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newServiceSummary :: ServiceSummary
- data SourceCodeVersion = SourceCodeVersion' SourceCodeVersionType Text
- newSourceCodeVersion :: SourceCodeVersionType -> Text -> SourceCodeVersion
- data SourceConfiguration = SourceConfiguration' (Maybe ImageRepository) (Maybe CodeRepository) (Maybe Bool) (Maybe AuthenticationConfiguration)
- newSourceConfiguration :: SourceConfiguration
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
Service Configuration
defaultService :: Service Source #
API version 2020-05-15
of the Amazon App Runner SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by AppRunner
.
InvalidRequestException
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
App Runner can't create this resource. You've reached your account quota for this resource type.
For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
InternalServiceErrorException
_InternalServiceErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An unexpected service exception occurred.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
InvalidStateException
_InvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't perform this action when the resource is in its current state.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListServices
data ListServices Source #
See: newListServices
smart constructor.
Instances
newListServices :: ListServices Source #
Create a value of ListServices
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:nextToken:ListServices'
, listServices_nextToken
- A token from a previous result page. Used for a paginated request. The
request retrieves the next result page. All other parameter values must
be identical to the ones specified in the initial request.
If you don't specify NextToken
, the request retrieves the first
result page.
$sel:maxResults:ListServices'
, listServices_maxResults
- The maximum number of results to include in each response (result page).
It's used for a paginated request.
If you don't specify MaxResults
, the request retrieves all available
results in a single response.
data ListServicesResponse Source #
See: newListServicesResponse
smart constructor.
Instances
newListServicesResponse Source #
Create a value of ListServicesResponse
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:nextToken:ListServices'
, listServicesResponse_nextToken
- The token that you can pass in a subsequent request to get the next
result page. It's returned in a paginated request.
$sel:httpStatus:ListServicesResponse'
, listServicesResponse_httpStatus
- The response's http status code.
$sel:serviceSummaryList:ListServicesResponse'
, listServicesResponse_serviceSummaryList
- A list of service summary information records. In a paginated request,
the request returns up to MaxResults
records for each call.
ResumeService
data ResumeService Source #
See: newResumeService
smart constructor.
Instances
Create a value of ResumeService
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:serviceArn:ResumeService'
, resumeService_serviceArn
- The Amazon Resource Name (ARN) of the App Runner service that you want
to resume.
data ResumeServiceResponse Source #
See: newResumeServiceResponse
smart constructor.
Instances
newResumeServiceResponse Source #
:: Int | |
-> Service | |
-> ResumeServiceResponse |
Create a value of ResumeServiceResponse
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:operationId:ResumeServiceResponse'
, resumeServiceResponse_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.
$sel:httpStatus:ResumeServiceResponse'
, resumeServiceResponse_httpStatus
- The response's http status code.
$sel:service:ResumeServiceResponse'
, resumeServiceResponse_service
- A description of the App Runner service that this request just resumed.
DeleteService
data DeleteService Source #
See: newDeleteService
smart constructor.
Instances
Create a value of DeleteService
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:serviceArn:DeleteService'
, deleteService_serviceArn
- The Amazon Resource Name (ARN) of the App Runner service that you want
to delete.
data DeleteServiceResponse Source #
See: newDeleteServiceResponse
smart constructor.
Instances
newDeleteServiceResponse Source #
:: Int | |
-> Service | |
-> Text | |
-> DeleteServiceResponse |
Create a value of DeleteServiceResponse
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:DeleteServiceResponse'
, deleteServiceResponse_httpStatus
- The response's http status code.
$sel:service:DeleteServiceResponse'
, deleteServiceResponse_service
- A description of the App Runner service that this request just deleted.
$sel:operationId:DeleteServiceResponse'
, deleteServiceResponse_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.
UpdateService
data UpdateService Source #
See: newUpdateService
smart constructor.
UpdateService' (Maybe Text) (Maybe HealthCheckConfiguration) (Maybe SourceConfiguration) (Maybe InstanceConfiguration) Text |
Instances
Create a value of UpdateService
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:autoScalingConfigurationArn:UpdateService'
, updateService_autoScalingConfigurationArn
- The Amazon Resource Name (ARN) of an App Runner automatic scaling
configuration resource that you want to associate with your service.
$sel:healthCheckConfiguration:UpdateService'
, updateService_healthCheckConfiguration
- The settings for the health check that App Runner performs to monitor
the health of your service.
$sel:sourceConfiguration:UpdateService'
, updateService_sourceConfiguration
- The source configuration to apply to the App Runner service.
You can change the configuration of the code or image repository that
the service uses. However, you can't switch from code to image or the
other way around. This means that you must provide the same structure
member of SourceConfiguration
that you originally included when you
created the service. Specifically, you can include either
CodeRepository
or ImageRepository
. To update the source
configuration, set the values to members of the structure that you
include.
$sel:instanceConfiguration:UpdateService'
, updateService_instanceConfiguration
- The runtime configuration to apply to instances (scaling units) of the
App Runner service.
$sel:serviceArn:UpdateService'
, updateService_serviceArn
- The Amazon Resource Name (ARN) of the App Runner service that you want
to update.
data UpdateServiceResponse Source #
See: newUpdateServiceResponse
smart constructor.
Instances
newUpdateServiceResponse Source #
:: Int | |
-> Service | |
-> Text | |
-> UpdateServiceResponse |
Create a value of UpdateServiceResponse
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:UpdateServiceResponse'
, updateServiceResponse_httpStatus
- The response's http status code.
$sel:service:UpdateServiceResponse'
, updateServiceResponse_service
- A description of the App Runner service updated by this request. All
configuration values in the returned Service
structure reflect
configuration changes that are being applied by this request.
$sel:operationId:UpdateServiceResponse'
, updateServiceResponse_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.
ListOperations
data ListOperations Source #
See: newListOperations
smart constructor.
Instances
Create a value of ListOperations
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:nextToken:ListOperations'
, listOperations_nextToken
- A token from a previous result page. It's used for a paginated request.
The request retrieves the next result page. All other parameter values
must be identical to the ones specified in the initial request.
If you don't specify NextToken
, the request retrieves the first
result page.
$sel:maxResults:ListOperations'
, listOperations_maxResults
- The maximum number of results to include in each response (result page).
It's used for a paginated request.
If you don't specify MaxResults
, the request retrieves all available
results in a single response.
$sel:serviceArn:ListOperations'
, listOperations_serviceArn
- The Amazon Resource Name (ARN) of the App Runner service that you want a
list of operations for.
data ListOperationsResponse Source #
See: newListOperationsResponse
smart constructor.
Instances
newListOperationsResponse Source #
Create a value of ListOperationsResponse
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:nextToken:ListOperations'
, listOperationsResponse_nextToken
- The token that you can pass in a subsequent request to get the next
result page. It's returned in a paginated request.
$sel:operationSummaryList:ListOperationsResponse'
, listOperationsResponse_operationSummaryList
- A list of operation summary information records. In a paginated request,
the request returns up to MaxResults
records for each call.
$sel:httpStatus:ListOperationsResponse'
, listOperationsResponse_httpStatus
- The response's http status code.
AssociateCustomDomain
data AssociateCustomDomain Source #
See: newAssociateCustomDomain
smart constructor.
Instances
newAssociateCustomDomain Source #
:: Text | |
-> Text | |
-> AssociateCustomDomain |
Create a value of AssociateCustomDomain
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:enableWWWSubdomain:AssociateCustomDomain'
, associateCustomDomain_enableWWWSubdomain
- Set to true
to associate the subdomain www.DomainName
with the App
Runner service in addition to the base domain.
Default: true
$sel:serviceArn:AssociateCustomDomain'
, associateCustomDomain_serviceArn
- The Amazon Resource Name (ARN) of the App Runner service that you want
to associate a custom domain name with.
$sel:domainName:AssociateCustomDomain'
, associateCustomDomain_domainName
- A custom domain endpoint to associate. Specify a root domain (for
example, example.com
), a subdomain (for example, login.example.com
or admin.login.example.com
), or a wildcard (for example,
*.example.com
).
data AssociateCustomDomainResponse Source #
See: newAssociateCustomDomainResponse
smart constructor.
Instances
newAssociateCustomDomainResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> CustomDomain | |
-> AssociateCustomDomainResponse |
Create a value of AssociateCustomDomainResponse
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:AssociateCustomDomainResponse'
, associateCustomDomainResponse_httpStatus
- The response's http status code.
$sel:dNSTarget:AssociateCustomDomainResponse'
, associateCustomDomainResponse_dNSTarget
- The App Runner subdomain of the App Runner service. The custom domain
name is mapped to this target name.
$sel:serviceArn:AssociateCustomDomain'
, associateCustomDomainResponse_serviceArn
- The Amazon Resource Name (ARN) of the App Runner service with which a
custom domain name is associated.
$sel:customDomain:AssociateCustomDomainResponse'
, associateCustomDomainResponse_customDomain
- A description of the domain name that's being associated.
ListConnections
data ListConnections Source #
See: newListConnections
smart constructor.
Instances
newListConnections :: ListConnections Source #
Create a value of ListConnections
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:connectionName:ListConnections'
, listConnections_connectionName
- If specified, only this connection is returned. If not specified, the
result isn't filtered by name.
$sel:nextToken:ListConnections'
, listConnections_nextToken
- A token from a previous result page. Used for a paginated request. The
request retrieves the next result page. All other parameter values must
be identical to the ones specified in the initial request.
If you don't specify NextToken
, the request retrieves the first
result page.
$sel:maxResults:ListConnections'
, listConnections_maxResults
- The maximum number of results to include in each response (result page).
Used for a paginated request.
If you don't specify MaxResults
, the request retrieves all available
results in a single response.
data ListConnectionsResponse Source #
See: newListConnectionsResponse
smart constructor.
Instances
newListConnectionsResponse Source #
Create a value of ListConnectionsResponse
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:nextToken:ListConnections'
, listConnectionsResponse_nextToken
- The token that you can pass in a subsequent request to get the next
result page. Returned in a paginated request.
$sel:httpStatus:ListConnectionsResponse'
, listConnectionsResponse_httpStatus
- The response's http status code.
$sel:connectionSummaryList:ListConnectionsResponse'
, listConnectionsResponse_connectionSummaryList
- A list of summary information records for connections. In a paginated
request, the request returns up to MaxResults
records for each call.
DeleteConnection
data DeleteConnection Source #
See: newDeleteConnection
smart constructor.
Instances
Create a value of DeleteConnection
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:DeleteConnection'
, deleteConnection_connectionArn
- The Amazon Resource Name (ARN) of the App Runner connection that you
want to delete.
data DeleteConnectionResponse Source #
See: newDeleteConnectionResponse
smart constructor.
Instances
newDeleteConnectionResponse Source #
Create a value of DeleteConnectionResponse
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:connection:DeleteConnectionResponse'
, deleteConnectionResponse_connection
- A description of the App Runner connection that this request just
deleted.
$sel:httpStatus:DeleteConnectionResponse'
, deleteConnectionResponse_httpStatus
- The response's http status code.
DescribeAutoScalingConfiguration
data DescribeAutoScalingConfiguration Source #
See: newDescribeAutoScalingConfiguration
smart constructor.
Instances
newDescribeAutoScalingConfiguration Source #
:: Text |
|
-> DescribeAutoScalingConfiguration |
Create a value of DescribeAutoScalingConfiguration
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:autoScalingConfigurationArn:DescribeAutoScalingConfiguration'
, describeAutoScalingConfiguration_autoScalingConfigurationArn
- The Amazon Resource Name (ARN) of the App Runner auto scaling
configuration that you want a description for.
The ARN can be a full auto scaling configuration ARN, or a partial ARN
ending with either .../name
or .../name/revision
. If a revision
isn't specified, the latest active revision is described.
data DescribeAutoScalingConfigurationResponse Source #
See: newDescribeAutoScalingConfigurationResponse
smart constructor.
Instances
newDescribeAutoScalingConfigurationResponse Source #
:: Int | |
-> AutoScalingConfiguration |
|
-> DescribeAutoScalingConfigurationResponse |
Create a value of DescribeAutoScalingConfigurationResponse
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:DescribeAutoScalingConfigurationResponse'
, describeAutoScalingConfigurationResponse_httpStatus
- The response's http status code.
$sel:autoScalingConfiguration:DescribeAutoScalingConfigurationResponse'
, describeAutoScalingConfigurationResponse_autoScalingConfiguration
- A full description of the App Runner auto scaling configuration that you
specified in this request.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) of the resource that a tag list is
requested for.
It must be the ARN of an App Runner resource.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- A list of the tag key-value pairs that are associated with the resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
CreateConnection
data CreateConnection Source #
See: newCreateConnection
smart constructor.
Instances
:: Text | |
-> ProviderType | |
-> 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:tags:CreateConnection'
, createConnection_tags
- A list of metadata items that you can associate with your connection
resource. A tag is a key-value pair.
$sel:connectionName:CreateConnection'
, createConnection_connectionName
- A name for the new connection. It must be unique across all App Runner
connections for the Amazon Web Services account in the Amazon Web
Services Region.
$sel:providerType:CreateConnection'
, createConnection_providerType
- The source repository provider.
data CreateConnectionResponse Source #
See: newCreateConnectionResponse
smart constructor.
Instances
newCreateConnectionResponse Source #
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:httpStatus:CreateConnectionResponse'
, createConnectionResponse_httpStatus
- The response's http status code.
$sel:connection:CreateConnectionResponse'
, createConnectionResponse_connection
- A description of the App Runner connection that's created by this
request.
DescribeCustomDomains
data DescribeCustomDomains Source #
See: newDescribeCustomDomains
smart constructor.
Instances
newDescribeCustomDomains Source #
Create a value of DescribeCustomDomains
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:nextToken:DescribeCustomDomains'
, describeCustomDomains_nextToken
- A token from a previous result page. It's used for a paginated request.
The request retrieves the next result page. All other parameter values
must be identical to the ones that are specified in the initial request.
If you don't specify NextToken
, the request retrieves the first
result page.
$sel:maxResults:DescribeCustomDomains'
, describeCustomDomains_maxResults
- The maximum number of results that each response (result page) can
include. It's used for a paginated request.
If you don't specify MaxResults
, the request retrieves all available
results in a single response.
$sel:serviceArn:DescribeCustomDomains'
, describeCustomDomains_serviceArn
- The Amazon Resource Name (ARN) of the App Runner service that you want
associated custom domain names to be described for.
data DescribeCustomDomainsResponse Source #
See: newDescribeCustomDomainsResponse
smart constructor.
Instances
newDescribeCustomDomainsResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> DescribeCustomDomainsResponse |
Create a value of DescribeCustomDomainsResponse
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:nextToken:DescribeCustomDomains'
, describeCustomDomainsResponse_nextToken
- The token that you can pass in a subsequent request to get the next
result page. It's returned in a paginated request.
$sel:httpStatus:DescribeCustomDomainsResponse'
, describeCustomDomainsResponse_httpStatus
- The response's http status code.
$sel:dNSTarget:DescribeCustomDomainsResponse'
, describeCustomDomainsResponse_dNSTarget
- The App Runner subdomain of the App Runner service. The associated
custom domain names are mapped to this target name.
$sel:serviceArn:DescribeCustomDomains'
, describeCustomDomainsResponse_serviceArn
- The Amazon Resource Name (ARN) of the App Runner service whose
associated custom domain names you want to describe.
$sel:customDomains:DescribeCustomDomainsResponse'
, describeCustomDomainsResponse_customDomains
- A list of descriptions of custom domain names that are associated with
the service. In a paginated request, the request returns up to
MaxResults
records per call.
DescribeService
data DescribeService Source #
See: newDescribeService
smart constructor.
Instances
Create a value of DescribeService
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:serviceArn:DescribeService'
, describeService_serviceArn
- The Amazon Resource Name (ARN) of the App Runner service that you want a
description for.
data DescribeServiceResponse Source #
See: newDescribeServiceResponse
smart constructor.
Instances
newDescribeServiceResponse Source #
:: Int | |
-> Service | |
-> DescribeServiceResponse |
Create a value of DescribeServiceResponse
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:DescribeServiceResponse'
, describeServiceResponse_httpStatus
- The response's http status code.
$sel:service:DescribeServiceResponse'
, describeServiceResponse_service
- A full description of the App Runner service that you specified in this
request.
DeleteAutoScalingConfiguration
data DeleteAutoScalingConfiguration Source #
See: newDeleteAutoScalingConfiguration
smart constructor.
Instances
newDeleteAutoScalingConfiguration Source #
:: Text |
|
-> DeleteAutoScalingConfiguration |
Create a value of DeleteAutoScalingConfiguration
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:autoScalingConfigurationArn:DeleteAutoScalingConfiguration'
, deleteAutoScalingConfiguration_autoScalingConfigurationArn
- The Amazon Resource Name (ARN) of the App Runner auto scaling
configuration that you want to delete.
The ARN can be a full auto scaling configuration ARN, or a partial ARN
ending with either .../name
or .../name/revision
. If a revision
isn't specified, the latest active revision is deleted.
data DeleteAutoScalingConfigurationResponse Source #
See: newDeleteAutoScalingConfigurationResponse
smart constructor.
Instances
newDeleteAutoScalingConfigurationResponse Source #
:: Int | |
-> AutoScalingConfiguration |
|
-> DeleteAutoScalingConfigurationResponse |
Create a value of DeleteAutoScalingConfigurationResponse
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:DeleteAutoScalingConfigurationResponse'
, deleteAutoScalingConfigurationResponse_httpStatus
- The response's http status code.
$sel:autoScalingConfiguration:DeleteAutoScalingConfigurationResponse'
, deleteAutoScalingConfigurationResponse_autoScalingConfiguration
- A description of the App Runner auto scaling configuration that this
request just deleted.
ListAutoScalingConfigurations
data ListAutoScalingConfigurations Source #
See: newListAutoScalingConfigurations
smart constructor.
Instances
newListAutoScalingConfigurations :: ListAutoScalingConfigurations Source #
Create a value of ListAutoScalingConfigurations
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:autoScalingConfigurationName:ListAutoScalingConfigurations'
, listAutoScalingConfigurations_autoScalingConfigurationName
- The name of the App Runner auto scaling configuration that you want to
list. If specified, App Runner lists revisions that share this name. If
not specified, App Runner returns revisions of all configurations.
$sel:nextToken:ListAutoScalingConfigurations'
, listAutoScalingConfigurations_nextToken
- A token from a previous result page. It's used for a paginated request.
The request retrieves the next result page. All other parameter values
must be identical to the ones that are specified in the initial request.
If you don't specify NextToken
, the request retrieves the first
result page.
$sel:latestOnly:ListAutoScalingConfigurations'
, listAutoScalingConfigurations_latestOnly
- Set to true
to list only the latest revision for each requested
configuration name.
Keep as false
to list all revisions for each requested configuration
name.
Default: false
$sel:maxResults:ListAutoScalingConfigurations'
, listAutoScalingConfigurations_maxResults
- The maximum number of results to include in each response (result page).
It's used for a paginated request.
If you don't specify MaxResults
, the request retrieves all available
results in a single response.
data ListAutoScalingConfigurationsResponse Source #
See: newListAutoScalingConfigurationsResponse
smart constructor.
Instances
newListAutoScalingConfigurationsResponse Source #
Create a value of ListAutoScalingConfigurationsResponse
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:nextToken:ListAutoScalingConfigurations'
, listAutoScalingConfigurationsResponse_nextToken
- The token that you can pass in a subsequent request to get the next
result page. It's returned in a paginated request.
$sel:httpStatus:ListAutoScalingConfigurationsResponse'
, listAutoScalingConfigurationsResponse_httpStatus
- The response's http status code.
$sel:autoScalingConfigurationSummaryList:ListAutoScalingConfigurationsResponse'
, listAutoScalingConfigurationsResponse_autoScalingConfigurationSummaryList
- A list of summary information records for auto scaling configurations.
In a paginated request, the request returns up to MaxResults
records
for each call.
DisassociateCustomDomain
data DisassociateCustomDomain Source #
See: newDisassociateCustomDomain
smart constructor.
Instances
newDisassociateCustomDomain Source #
:: Text | |
-> Text | |
-> DisassociateCustomDomain |
Create a value of DisassociateCustomDomain
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:serviceArn:DisassociateCustomDomain'
, disassociateCustomDomain_serviceArn
- The Amazon Resource Name (ARN) of the App Runner service that you want
to disassociate a custom domain name from.
$sel:domainName:DisassociateCustomDomain'
, disassociateCustomDomain_domainName
- The domain name that you want to disassociate from the App Runner
service.
data DisassociateCustomDomainResponse Source #
See: newDisassociateCustomDomainResponse
smart constructor.
Instances
newDisassociateCustomDomainResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> CustomDomain | |
-> DisassociateCustomDomainResponse |
Create a value of DisassociateCustomDomainResponse
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:DisassociateCustomDomainResponse'
, disassociateCustomDomainResponse_httpStatus
- The response's http status code.
$sel:dNSTarget:DisassociateCustomDomainResponse'
, disassociateCustomDomainResponse_dNSTarget
- The App Runner subdomain of the App Runner service. The disassociated
custom domain name was mapped to this target name.
$sel:serviceArn:DisassociateCustomDomain'
, disassociateCustomDomainResponse_serviceArn
- The Amazon Resource Name (ARN) of the App Runner service that a custom
domain name is disassociated from.
$sel:customDomain:DisassociateCustomDomainResponse'
, disassociateCustomDomainResponse_customDomain
- A description of the domain name that's being disassociated.
PauseService
data PauseService Source #
See: newPauseService
smart constructor.
Instances
Create a value of PauseService
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:serviceArn:PauseService'
, pauseService_serviceArn
- The Amazon Resource Name (ARN) of the App Runner service that you want
to pause.
data PauseServiceResponse Source #
See: newPauseServiceResponse
smart constructor.
Instances
newPauseServiceResponse Source #
:: Int | |
-> Service | |
-> PauseServiceResponse |
Create a value of PauseServiceResponse
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:operationId:PauseServiceResponse'
, pauseServiceResponse_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.
$sel:httpStatus:PauseServiceResponse'
, pauseServiceResponse_httpStatus
- The response's http status code.
$sel:service:PauseServiceResponse'
, pauseServiceResponse_service
- A description of the App Runner service that this request just paused.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- The Amazon Resource Name (ARN) of the resource that you want to update
tags for.
It must be the ARN of an App Runner resource.
$sel:tags:TagResource'
, tagResource_tags
- A list of tag key-value pairs to add or update. If a key is new to the
resource, the tag is added with the provided value. If a key is already
associated with the resource, the value of the tag is updated.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- The Amazon Resource Name (ARN) of the resource that you want to remove
tags from.
It must be the ARN of an App Runner resource.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- A list of tag keys that you want to remove.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
CreateAutoScalingConfiguration
data CreateAutoScalingConfiguration Source #
See: newCreateAutoScalingConfiguration
smart constructor.
Instances
newCreateAutoScalingConfiguration Source #
:: Text |
|
-> CreateAutoScalingConfiguration |
Create a value of CreateAutoScalingConfiguration
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:maxSize:CreateAutoScalingConfiguration'
, createAutoScalingConfiguration_maxSize
- The maximum number of instances that your service scales up to. At most
MaxSize
instances actively serve traffic for your service.
Default: 25
$sel:minSize:CreateAutoScalingConfiguration'
, createAutoScalingConfiguration_minSize
- The minimum number of instances that App Runner provisions for your
service. The service always has at least MinSize
provisioned
instances. Some of them actively serve traffic. The rest of them
(provisioned and inactive instances) are a cost-effective compute
capacity reserve and are ready to be quickly activated. You pay for
memory usage of all the provisioned instances. You pay for CPU usage of
only the active subset.
App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.
Default: 1
$sel:tags:CreateAutoScalingConfiguration'
, createAutoScalingConfiguration_tags
- A list of metadata items that you can associate with your auto scaling
configuration resource. A tag is a key-value pair.
$sel:maxConcurrency:CreateAutoScalingConfiguration'
, createAutoScalingConfiguration_maxConcurrency
- The maximum number of concurrent requests that you want an instance to
process. If the number of concurrent requests exceeds this limit, App
Runner scales up your service.
Default: 100
$sel:autoScalingConfigurationName:CreateAutoScalingConfiguration'
, createAutoScalingConfiguration_autoScalingConfigurationName
- A name for the auto scaling configuration. When you use it for the first
time in an Amazon Web Services Region, App Runner creates revision
number 1
of this name. When you use the same name in subsequent calls,
App Runner creates incremental revisions of the configuration.
data CreateAutoScalingConfigurationResponse Source #
See: newCreateAutoScalingConfigurationResponse
smart constructor.
Instances
newCreateAutoScalingConfigurationResponse Source #
:: Int | |
-> AutoScalingConfiguration |
|
-> CreateAutoScalingConfigurationResponse |
Create a value of CreateAutoScalingConfigurationResponse
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:CreateAutoScalingConfigurationResponse'
, createAutoScalingConfigurationResponse_httpStatus
- The response's http status code.
$sel:autoScalingConfiguration:CreateAutoScalingConfigurationResponse'
, createAutoScalingConfigurationResponse_autoScalingConfiguration
- A description of the App Runner auto scaling configuration that's
created by this request.
StartDeployment
data StartDeployment Source #
See: newStartDeployment
smart constructor.
Instances
Create a value of StartDeployment
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:serviceArn:StartDeployment'
, startDeployment_serviceArn
- The Amazon Resource Name (ARN) of the App Runner service that you want
to manually deploy to.
data StartDeploymentResponse Source #
See: newStartDeploymentResponse
smart constructor.
Instances
newStartDeploymentResponse Source #
:: Int | |
-> Text | |
-> StartDeploymentResponse |
Create a value of StartDeploymentResponse
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:StartDeploymentResponse'
, startDeploymentResponse_httpStatus
- The response's http status code.
$sel:operationId:StartDeploymentResponse'
, startDeploymentResponse_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.
CreateService
data CreateService Source #
See: newCreateService
smart constructor.
CreateService' (Maybe Text) (Maybe EncryptionConfiguration) (Maybe HealthCheckConfiguration) (Maybe [Tag]) (Maybe InstanceConfiguration) Text SourceConfiguration |
Instances
:: Text | |
-> SourceConfiguration | |
-> 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:
$sel:autoScalingConfigurationArn: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.
$sel:encryptionConfiguration: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 CMK.
$sel:healthCheckConfiguration:CreateService'
, createService_healthCheckConfiguration
- The settings for the health check that App Runner performs to monitor
the health of your service.
$sel:tags:CreateService'
, createService_tags
- An optional list of metadata items that you can associate with your
service resource. A tag is a key-value pair.
$sel:instanceConfiguration:CreateService'
, createService_instanceConfiguration
- The runtime configuration of instances (scaling units) of the App Runner
service.
$sel:serviceName:CreateService'
, createService_serviceName
- A name for the new service. It must be unique across all the running App
Runner services in your Amazon Web Services account in the Amazon Web
Services Region.
$sel:sourceConfiguration:CreateService'
, createService_sourceConfiguration
- The source to deploy to the App Runner service. It can be a code or an
image repository.
data CreateServiceResponse Source #
See: newCreateServiceResponse
smart constructor.
Instances
newCreateServiceResponse Source #
:: Int | |
-> Service | |
-> Text | |
-> 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.
Types
AutoScalingConfigurationStatus
newtype AutoScalingConfigurationStatus Source #
pattern AutoScalingConfigurationStatus_ACTIVE :: AutoScalingConfigurationStatus | |
pattern AutoScalingConfigurationStatus_INACTIVE :: AutoScalingConfigurationStatus |
Instances
CertificateValidationRecordStatus
newtype CertificateValidationRecordStatus Source #
Instances
ConfigurationSource
newtype ConfigurationSource Source #
pattern ConfigurationSource_API :: ConfigurationSource | |
pattern ConfigurationSource_REPOSITORY :: ConfigurationSource |
Instances
ConnectionStatus
newtype ConnectionStatus Source #
pattern ConnectionStatus_AVAILABLE :: ConnectionStatus | |
pattern ConnectionStatus_DELETED :: ConnectionStatus | |
pattern ConnectionStatus_ERROR :: ConnectionStatus | |
pattern ConnectionStatus_PENDING_HANDSHAKE :: ConnectionStatus |
Instances
CustomDomainAssociationStatus
newtype CustomDomainAssociationStatus Source #
Instances
HealthCheckProtocol
newtype HealthCheckProtocol Source #
pattern HealthCheckProtocol_HTTP :: HealthCheckProtocol | |
pattern HealthCheckProtocol_TCP :: HealthCheckProtocol |
Instances
ImageRepositoryType
newtype ImageRepositoryType Source #
pattern ImageRepositoryType_ECR :: ImageRepositoryType | |
pattern ImageRepositoryType_ECR_PUBLIC :: ImageRepositoryType |
Instances
OperationStatus
newtype OperationStatus Source #
pattern OperationStatus_FAILED :: OperationStatus | |
pattern OperationStatus_IN_PROGRESS :: OperationStatus | |
pattern OperationStatus_PENDING :: OperationStatus | |
pattern OperationStatus_ROLLBACK_FAILED :: OperationStatus | |
pattern OperationStatus_ROLLBACK_IN_PROGRESS :: OperationStatus | |
pattern OperationStatus_ROLLBACK_SUCCEEDED :: OperationStatus | |
pattern OperationStatus_SUCCEEDED :: OperationStatus |
Instances
OperationType
newtype OperationType Source #
pattern OperationType_CREATE_SERVICE :: OperationType | |
pattern OperationType_DELETE_SERVICE :: OperationType | |
pattern OperationType_PAUSE_SERVICE :: OperationType | |
pattern OperationType_RESUME_SERVICE :: OperationType | |
pattern OperationType_START_DEPLOYMENT :: OperationType |
Instances
ProviderType
newtype ProviderType Source #
pattern ProviderType_GITHUB :: ProviderType |
Instances
Runtime
pattern Runtime_NODEJS_12 :: Runtime | |
pattern Runtime_PYTHON_3 :: Runtime |
Instances
ServiceStatus
newtype ServiceStatus Source #
pattern ServiceStatus_CREATE_FAILED :: ServiceStatus | |
pattern ServiceStatus_DELETED :: ServiceStatus | |
pattern ServiceStatus_DELETE_FAILED :: ServiceStatus | |
pattern ServiceStatus_OPERATION_IN_PROGRESS :: ServiceStatus | |
pattern ServiceStatus_PAUSED :: ServiceStatus | |
pattern ServiceStatus_RUNNING :: ServiceStatus |
Instances
SourceCodeVersionType
newtype SourceCodeVersionType Source #
Instances
AuthenticationConfiguration
data AuthenticationConfiguration Source #
Describes resources needed to authenticate access to some source repositories. The specific resource depends on the repository provider.
See: newAuthenticationConfiguration
smart constructor.
Instances
newAuthenticationConfiguration :: AuthenticationConfiguration Source #
Create a value of AuthenticationConfiguration
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:accessRoleArn:AuthenticationConfiguration'
, authenticationConfiguration_accessRoleArn
- The Amazon Resource Name (ARN) of the IAM role that grants the App
Runner service access to a source repository. It's required for ECR
image repositories (but not for ECR Public repositories).
$sel:connectionArn:AuthenticationConfiguration'
, authenticationConfiguration_connectionArn
- The Amazon Resource Name (ARN) of the App Runner connection that enables
the App Runner service to connect to a source repository. It's required
for GitHub code repositories.
AutoScalingConfiguration
data AutoScalingConfiguration Source #
Describes an App Runner automatic scaling configuration resource.
Multiple revisions of a configuration have the same
AutoScalingConfigurationName
and different
AutoScalingConfigurationRevision
values.
A higher MinSize
increases the spread of your App Runner service over
more Availability Zones in the Amazon Web Services Region. The tradeoff
is a higher minimal cost.
A lower MaxSize
controls your cost. The tradeoff is lower
responsiveness during peak demand.
See: newAutoScalingConfiguration
smart constructor.
AutoScalingConfiguration' (Maybe AutoScalingConfigurationStatus) (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe POSIX) (Maybe Bool) (Maybe Int) |
Instances
newAutoScalingConfiguration :: AutoScalingConfiguration Source #
Create a value of AutoScalingConfiguration
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:status:AutoScalingConfiguration'
, autoScalingConfiguration_status
- The current state of the auto scaling configuration. If the status of a
configuration revision is INACTIVE
, it was deleted and can't be used.
Inactive configuration revisions are permanently removed some time after
they are deleted.
$sel:autoScalingConfigurationName:AutoScalingConfiguration'
, autoScalingConfiguration_autoScalingConfigurationName
- The customer-provided auto scaling configuration name. It can be used in
multiple revisions of a configuration.
$sel:createdAt:AutoScalingConfiguration'
, autoScalingConfiguration_createdAt
- The time when the auto scaling configuration was created. It's in Unix
time stamp format.
$sel:maxSize:AutoScalingConfiguration'
, autoScalingConfiguration_maxSize
- The maximum number of instances that a service scales up to. At most
MaxSize
instances actively serve traffic for your service.
$sel:autoScalingConfigurationRevision:AutoScalingConfiguration'
, autoScalingConfiguration_autoScalingConfigurationRevision
- The revision of this auto scaling configuration. It's unique among all
the active configurations ("Status": "ACTIVE"
) that share the same
AutoScalingConfigurationName
.
$sel:autoScalingConfigurationArn:AutoScalingConfiguration'
, autoScalingConfiguration_autoScalingConfigurationArn
- The Amazon Resource Name (ARN) of this auto scaling configuration.
$sel:minSize:AutoScalingConfiguration'
, autoScalingConfiguration_minSize
- The minimum number of instances that App Runner provisions for a
service. The service always has at least MinSize
provisioned
instances. Some of them actively serve traffic. The rest of them
(provisioned and inactive instances) are a cost-effective compute
capacity reserve and are ready to be quickly activated. You pay for
memory usage of all the provisioned instances. You pay for CPU usage of
only the active subset.
App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.
$sel:deletedAt:AutoScalingConfiguration'
, autoScalingConfiguration_deletedAt
- The time when the auto scaling configuration was deleted. It's in Unix
time stamp format.
$sel:latest:AutoScalingConfiguration'
, autoScalingConfiguration_latest
- It's set to true
for the configuration with the highest Revision
among all configurations that share the same Name
. It's set to
false
otherwise.
$sel:maxConcurrency:AutoScalingConfiguration'
, autoScalingConfiguration_maxConcurrency
- The maximum number of concurrent requests that an instance processes. If
the number of concurrent requests exceeds this limit, App Runner scales
the service up.
AutoScalingConfigurationSummary
data AutoScalingConfigurationSummary Source #
Provides summary information about an App Runner automatic scaling configuration resource.
This type contains limited information about an auto scaling configuration. It includes only identification information, without configuration details. It's returned by the ListAutoScalingConfigurations action. Complete configuration information is returned by the CreateAutoScalingConfiguration, DescribeAutoScalingConfiguration, and DeleteAutoScalingConfiguration actions using the AutoScalingConfiguration type.
See: newAutoScalingConfigurationSummary
smart constructor.
Instances
newAutoScalingConfigurationSummary :: AutoScalingConfigurationSummary Source #
Create a value of AutoScalingConfigurationSummary
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:autoScalingConfigurationName:AutoScalingConfigurationSummary'
, autoScalingConfigurationSummary_autoScalingConfigurationName
- The customer-provided auto scaling configuration name. It can be used in
multiple revisions of a configuration.
$sel:autoScalingConfigurationRevision:AutoScalingConfigurationSummary'
, autoScalingConfigurationSummary_autoScalingConfigurationRevision
- The revision of this auto scaling configuration. It's unique among all
the active configurations ("Status": "ACTIVE"
) with the same
AutoScalingConfigurationName
.
$sel:autoScalingConfigurationArn:AutoScalingConfigurationSummary'
, autoScalingConfigurationSummary_autoScalingConfigurationArn
- The Amazon Resource Name (ARN) of this auto scaling configuration.
CertificateValidationRecord
data CertificateValidationRecord Source #
Describes a certificate CNAME record to add to your DNS. For more information, see AssociateCustomDomain.
See: newCertificateValidationRecord
smart constructor.
CertificateValidationRecord' (Maybe CertificateValidationRecordStatus) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newCertificateValidationRecord :: CertificateValidationRecord Source #
Create a value of CertificateValidationRecord
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:status:CertificateValidationRecord'
, certificateValidationRecord_status
- The current state of the certificate CNAME record validation. It should
change to SUCCESS
after App Runner completes validation with your DNS.
$sel:value:CertificateValidationRecord'
, certificateValidationRecord_value
- The certificate CNAME record value.
$sel:name:CertificateValidationRecord'
, certificateValidationRecord_name
- The certificate CNAME record name.
$sel:type':CertificateValidationRecord'
, certificateValidationRecord_type
- The record type, always CNAME
.
CodeConfiguration
data CodeConfiguration Source #
Describes the configuration that App Runner uses to build and run an App Runner service from a source code repository.
See: newCodeConfiguration
smart constructor.
Instances
Create a value of CodeConfiguration
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:codeConfigurationValues:CodeConfiguration'
, codeConfiguration_codeConfigurationValues
- The basic configuration for building and running the App Runner service.
Use it to quickly launch an App Runner service without providing a
apprunner.yaml
file in the source code repository (or ignoring the
file if it exists).
$sel:configurationSource:CodeConfiguration'
, codeConfiguration_configurationSource
- The source of the App Runner configuration. Values are interpreted as
follows:
REPOSITORY
– App Runner reads configuration values from theapprunner.yaml
file in the source code repository and ignoresCodeConfigurationValues
.API
– App Runner uses configuration values provided inCodeConfigurationValues
and ignores theapprunner.yaml
file in the source code repository.
CodeConfigurationValues
data CodeConfigurationValues Source #
Describes the basic configuration needed for building and running an App
Runner service. This type doesn't support the full set of possible
configuration options. Fur full configuration capabilities, use a
apprunner.yaml
file in the source code repository.
See: newCodeConfigurationValues
smart constructor.
CodeConfigurationValues' (Maybe (Sensitive Text)) (Maybe (HashMap Text (Sensitive Text))) (Maybe (Sensitive Text)) (Maybe Text) Runtime |
Instances
newCodeConfigurationValues Source #
Create a value of CodeConfigurationValues
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:startCommand:CodeConfigurationValues'
, codeConfigurationValues_startCommand
- The command App Runner runs to start your application.
$sel:runtimeEnvironmentVariables:CodeConfigurationValues'
, codeConfigurationValues_runtimeEnvironmentVariables
- The environment variables that are available to your running App Runner
service. An array of key-value pairs. Keys with a prefix of
AWSAPPRUNNER
are reserved for system use and aren't valid.
$sel:buildCommand:CodeConfigurationValues'
, codeConfigurationValues_buildCommand
- The command App Runner runs to build your application.
$sel:port:CodeConfigurationValues'
, codeConfigurationValues_port
- The port that your application listens to in the container.
Default: 8080
$sel:runtime:CodeConfigurationValues'
, codeConfigurationValues_runtime
- A runtime environment type for building and running an App Runner
service. It represents a programming language runtime.
CodeRepository
data CodeRepository Source #
Describes a source code repository.
See: newCodeRepository
smart constructor.
Instances
:: Text | |
-> SourceCodeVersion | |
-> CodeRepository |
Create a value of CodeRepository
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:codeConfiguration:CodeRepository'
, codeRepository_codeConfiguration
- Configuration for building and running the service from a source code
repository.
$sel:repositoryUrl:CodeRepository'
, codeRepository_repositoryUrl
- The location of the repository that contains the source code.
$sel:sourceCodeVersion:CodeRepository'
, codeRepository_sourceCodeVersion
- The version that should be used within the source code repository.
Connection
data Connection Source #
Describes an App Runner connection resource.
See: newConnection
smart constructor.
Connection' (Maybe ConnectionStatus) (Maybe POSIX) (Maybe ProviderType) (Maybe Text) (Maybe Text) |
Instances
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:status:Connection'
, connection_status
- The current state of the App Runner connection. When the state is
AVAILABLE
, you can use the connection to create an App Runner service.
$sel:createdAt:Connection'
, connection_createdAt
- The App Runner connection creation time, expressed as a Unix time stamp.
$sel:providerType:Connection'
, connection_providerType
- The source repository provider.
$sel:connectionName:Connection'
, connection_connectionName
- The customer-provided connection name.
$sel:connectionArn:Connection'
, connection_connectionArn
- The Amazon Resource Name (ARN) of this connection.
ConnectionSummary
data ConnectionSummary Source #
Provides summary information about an App Runner connection resource.
See: newConnectionSummary
smart constructor.
ConnectionSummary' (Maybe ConnectionStatus) (Maybe POSIX) (Maybe ProviderType) (Maybe Text) (Maybe Text) |
Instances
newConnectionSummary :: ConnectionSummary Source #
Create a value of ConnectionSummary
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:status:ConnectionSummary'
, connectionSummary_status
- The current state of the App Runner connection. When the state is
AVAILABLE
, you can use the connection to create an App Runner service.
$sel:createdAt:ConnectionSummary'
, connectionSummary_createdAt
- The App Runner connection creation time, expressed as a Unix time stamp.
$sel:providerType:ConnectionSummary'
, connectionSummary_providerType
- The source repository provider.
$sel:connectionName:ConnectionSummary'
, connectionSummary_connectionName
- The customer-provided connection name.
$sel:connectionArn:ConnectionSummary'
, connectionSummary_connectionArn
- The Amazon Resource Name (ARN) of this connection.
CustomDomain
data CustomDomain Source #
Describes a custom domain that's associated with an App Runner service.
See: newCustomDomain
smart constructor.
Instances
Create a value of CustomDomain
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:certificateValidationRecords:CustomDomain'
, customDomain_certificateValidationRecords
- A list of certificate CNAME records that's used for this domain name.
$sel:domainName:CustomDomain'
, customDomain_domainName
- An associated custom domain endpoint. It can be a root domain (for
example, example.com
), a subdomain (for example, login.example.com
or admin.login.example.com
), or a wildcard (for example,
*.example.com
).
$sel:enableWWWSubdomain:CustomDomain'
, customDomain_enableWWWSubdomain
- When true
, the subdomain www.DomainName
is associated with the App
Runner service in addition to the base domain.
$sel:status:CustomDomain'
, customDomain_status
- The current state of the domain name association.
EncryptionConfiguration
data EncryptionConfiguration Source #
Describes a custom encryption key that App Runner uses to encrypt copies of the source repository and service logs.
See: newEncryptionConfiguration
smart constructor.
Instances
newEncryptionConfiguration Source #
Create a value of EncryptionConfiguration
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:kmsKey:EncryptionConfiguration'
, encryptionConfiguration_kmsKey
- The ARN of the KMS key that's used for encryption.
HealthCheckConfiguration
data HealthCheckConfiguration Source #
Describes the settings for the health check that App Runner performs to monitor the health of a service.
See: newHealthCheckConfiguration
smart constructor.
HealthCheckConfiguration' (Maybe Natural) (Maybe Text) (Maybe HealthCheckProtocol) (Maybe Natural) (Maybe Natural) (Maybe Natural) |
Instances
newHealthCheckConfiguration :: HealthCheckConfiguration Source #
Create a value of HealthCheckConfiguration
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:healthyThreshold:HealthCheckConfiguration'
, healthCheckConfiguration_healthyThreshold
- The number of consecutive checks that must succeed before App Runner
decides that the service is healthy.
Default: 1
$sel:path:HealthCheckConfiguration'
, healthCheckConfiguration_path
- The URL that health check requests are sent to.
Path
is only applicable when you set Protocol
to HTTP
.
Default: "/"
$sel:protocol:HealthCheckConfiguration'
, healthCheckConfiguration_protocol
- The IP protocol that App Runner uses to perform health checks for your
service.
If you set Protocol
to HTTP
, App Runner sends health check requests
to the HTTP path specified by Path
.
Default: TCP
$sel:interval:HealthCheckConfiguration'
, healthCheckConfiguration_interval
- The time interval, in seconds, between health checks.
Default: 5
$sel:timeout:HealthCheckConfiguration'
, healthCheckConfiguration_timeout
- The time, in seconds, to wait for a health check response before
deciding it failed.
Default: 2
$sel:unhealthyThreshold:HealthCheckConfiguration'
, healthCheckConfiguration_unhealthyThreshold
- The number of consecutive checks that must fail before App Runner
decides that the service is unhealthy.
Default: 5
ImageConfiguration
data ImageConfiguration Source #
Describes the configuration that App Runner uses to run an App Runner service using an image pulled from a source image repository.
See: newImageConfiguration
smart constructor.
Instances
newImageConfiguration :: ImageConfiguration Source #
Create a value of ImageConfiguration
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:startCommand:ImageConfiguration'
, imageConfiguration_startCommand
- An optional command that App Runner runs to start the application in the
source image. If specified, this command overrides the Docker image’s
default start command.
$sel:runtimeEnvironmentVariables:ImageConfiguration'
, imageConfiguration_runtimeEnvironmentVariables
- Environment variables that are available to your running App Runner
service. An array of key-value pairs. Keys with a prefix of
AWSAPPRUNNER
are reserved for system use and aren't valid.
$sel:port:ImageConfiguration'
, imageConfiguration_port
- The port that your application listens to in the container.
Default: 8080
ImageRepository
data ImageRepository Source #
Describes a source image repository.
See: newImageRepository
smart constructor.
Instances
Create a value of ImageRepository
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:imageConfiguration:ImageRepository'
, imageRepository_imageConfiguration
- Configuration for running the identified image.
$sel:imageIdentifier:ImageRepository'
, imageRepository_imageIdentifier
- The identifier of an image.
For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see Pulling an image in the Amazon ECR User Guide.
$sel:imageRepositoryType:ImageRepository'
, imageRepository_imageRepositoryType
- The type of the image repository. This reflects the repository provider
and whether the repository is private or public.
InstanceConfiguration
data InstanceConfiguration Source #
Describes the runtime configuration of an App Runner service instance (scaling unit).
See: newInstanceConfiguration
smart constructor.
Instances
newInstanceConfiguration :: InstanceConfiguration Source #
Create a value of InstanceConfiguration
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:memory:InstanceConfiguration'
, instanceConfiguration_memory
- The amount of memory, in MB or GB, reserved for each instance of your
App Runner service.
Default: 2 GB
$sel:instanceRoleArn:InstanceConfiguration'
, instanceConfiguration_instanceRoleArn
- The Amazon Resource Name (ARN) of an IAM role that provides permissions
to your App Runner service. These are permissions that your code needs
when it calls any Amazon Web Services APIs.
$sel:cpu:InstanceConfiguration'
, instanceConfiguration_cpu
- The number of CPU units reserved for each instance of your App Runner
service.
Default: 1 vCPU
OperationSummary
data OperationSummary Source #
Provides summary information for an operation that occurred on an App Runner service.
See: newOperationSummary
smart constructor.
OperationSummary' (Maybe OperationStatus) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe OperationType) (Maybe POSIX) |
Instances
newOperationSummary :: OperationSummary Source #
Create a value of OperationSummary
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:status:OperationSummary'
, operationSummary_status
- The current state of the operation.
$sel:targetArn:OperationSummary'
, operationSummary_targetArn
- The Amazon Resource Name (ARN) of the resource that the operation acted
on (for example, an App Runner service).
$sel:endedAt:OperationSummary'
, operationSummary_endedAt
- The time when the operation ended. It's in the Unix time stamp format.
$sel:startedAt:OperationSummary'
, operationSummary_startedAt
- The time when the operation started. It's in the Unix time stamp
format.
$sel:id:OperationSummary'
, operationSummary_id
- A unique ID of this operation. It's unique in the scope of the App
Runner service.
$sel:type':OperationSummary'
, operationSummary_type
- The type of operation. It indicates a specific action that occured.
$sel:updatedAt:OperationSummary'
, operationSummary_updatedAt
- The time when the operation was last updated. It's in the Unix time
stamp format.
Service
Describes an App Runner service. It can describe a service in any state, including deleted services.
This type contains the full information about a service, including configuration details. It's returned by the CreateService, DescribeService, and DeleteService actions. A subset of this information is returned by the ListServices action using the ServiceSummary type.
See: newService
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> ServiceStatus | |
-> SourceConfiguration | |
-> InstanceConfiguration | |
-> AutoScalingConfigurationSummary | |
-> Service |
Create a value of Service
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:encryptionConfiguration:Service'
, service_encryptionConfiguration
- The encryption key that App Runner uses to encrypt the service logs and
the copy of the source repository that App Runner maintains for the
service. It can be either a customer-provided encryption key or an
Amazon Web Services managed CMK.
$sel:healthCheckConfiguration:Service'
, service_healthCheckConfiguration
- The settings for the health check that App Runner performs to monitor
the health of this service.
$sel:deletedAt:Service'
, service_deletedAt
- The time when the App Runner service was deleted. It's in the Unix time
stamp format.
$sel:serviceName:Service'
, service_serviceName
- The customer-provided service name.
$sel:serviceId:Service'
, service_serviceId
- An ID that App Runner generated for this service. It's unique within
the Amazon Web Services Region.
$sel:serviceArn:Service'
, service_serviceArn
- The Amazon Resource Name (ARN) of this service.
$sel:serviceUrl:Service'
, service_serviceUrl
- A subdomain URL that App Runner generated for this service. You can use
this URL to access your service web application.
$sel:createdAt:Service'
, service_createdAt
- The time when the App Runner service was created. It's in the Unix time
stamp format.
$sel:updatedAt:Service'
, service_updatedAt
- The time when the App Runner service was last updated at. It's in the
Unix time stamp format.
$sel:status:Service'
, service_status
- The current state of the App Runner service. These particular values
mean the following.
CREATE_FAILED
– The service failed to create. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service.The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.
DELETE_FAILED
– The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.
$sel:sourceConfiguration:Service'
, service_sourceConfiguration
- The source deployed to the App Runner service. It can be a code or an
image repository.
$sel:instanceConfiguration:Service'
, service_instanceConfiguration
- The runtime configuration of instances (scaling units) of this service.
$sel:autoScalingConfigurationSummary:Service'
, service_autoScalingConfigurationSummary
- Summary information for the App Runner automatic scaling configuration
resource that's associated with this service.
ServiceSummary
data ServiceSummary Source #
Provides summary information for an App Runner service.
This type contains limited information about a service. It doesn't include configuration details. It's returned by the ListServices action. Complete service information is returned by the CreateService, DescribeService, and DeleteService actions using the Service type.
See: newServiceSummary
smart constructor.
ServiceSummary' (Maybe ServiceStatus) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) |
Instances
newServiceSummary :: ServiceSummary Source #
Create a value of ServiceSummary
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:status:ServiceSummary'
, serviceSummary_status
- The current state of the App Runner service. These particular values
mean the following.
CREATE_FAILED
– The service failed to create. Read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service.The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.
DELETE_FAILED
– The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.
$sel:createdAt:ServiceSummary'
, serviceSummary_createdAt
- The time when the App Runner service was created. It's in the Unix time
stamp format.
$sel:serviceUrl:ServiceSummary'
, serviceSummary_serviceUrl
- A subdomain URL that App Runner generated for this service. You can use
this URL to access your service web application.
$sel:serviceName:ServiceSummary'
, serviceSummary_serviceName
- The customer-provided service name.
$sel:updatedAt:ServiceSummary'
, serviceSummary_updatedAt
- The time when the App Runner service was last updated. It's in theUnix
time stamp format.
$sel:serviceArn:ServiceSummary'
, serviceSummary_serviceArn
- The Amazon Resource Name (ARN) of this service.
$sel:serviceId:ServiceSummary'
, serviceSummary_serviceId
- An ID that App Runner generated for this service. It's unique within
the Amazon Web Services Region.
SourceCodeVersion
data SourceCodeVersion Source #
Identifies a version of code that App Runner refers to within a source code repository.
See: newSourceCodeVersion
smart constructor.
Instances
Create a value of SourceCodeVersion
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:type':SourceCodeVersion'
, sourceCodeVersion_type
- The type of version identifier.
For a git-based repository, branches represent versions.
$sel:value:SourceCodeVersion'
, sourceCodeVersion_value
- A source code version.
For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.
SourceConfiguration
data SourceConfiguration Source #
Describes the source deployed to an App Runner service. It can be a code or an image repository.
See: newSourceConfiguration
smart constructor.
SourceConfiguration' (Maybe ImageRepository) (Maybe CodeRepository) (Maybe Bool) (Maybe AuthenticationConfiguration) |
Instances
newSourceConfiguration :: SourceConfiguration Source #
Create a value of SourceConfiguration
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:imageRepository:SourceConfiguration'
, sourceConfiguration_imageRepository
- The description of a source image repository.
You must provide either this member or CodeRepository
(but not both).
$sel:codeRepository:SourceConfiguration'
, sourceConfiguration_codeRepository
- The description of a source code repository.
You must provide either this member or ImageRepository
(but not both).
$sel:autoDeploymentsEnabled:SourceConfiguration'
, sourceConfiguration_autoDeploymentsEnabled
- If true
, continuous integration from the source repository is enabled
for the App Runner service. Each repository change (including any source
code commit or new image version) starts a deployment.
Default: App Runner sets to false
for a source image that uses an ECR
Public repository or an ECR repository that's in an Amazon Web Services
account other than the one that the service is in. App Runner sets to
true
in all other cases (which currently include a source code
repository or a source image using a same-account ECR repository).
$sel:authenticationConfiguration:SourceConfiguration'
, sourceConfiguration_authenticationConfiguration
- Describes the resources that are needed to authenticate access to some
source repositories.
Tag
Describes a tag that is applied to an App Runner resource. A tag is a metadata item consisting of a key-value pair.
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.AppRunner.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.AppRunner.Types.Tag | |
ToJSON Tag Source # | |
Defined in Amazonka.AppRunner.Types.Tag | |
FromJSON Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.AppRunner.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.AppRunner.Types.Tag" "libZSservicesZSamazonka-apprunnerZSamazonka-apprunner" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
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:value:Tag'
, tag_value
- The value of the tag.
$sel:key:Tag'
, tag_key
- The key of the tag.