| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.AppRunner.Types
Contents
- Service Configuration
- Errors
- 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
Description
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
- 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' {}
- newAuthenticationConfiguration :: AuthenticationConfiguration
- authenticationConfiguration_accessRoleArn :: Lens' AuthenticationConfiguration (Maybe Text)
- authenticationConfiguration_connectionArn :: Lens' AuthenticationConfiguration (Maybe Text)
- data AutoScalingConfiguration = AutoScalingConfiguration' {
- status :: Maybe AutoScalingConfigurationStatus
- autoScalingConfigurationName :: Maybe Text
- createdAt :: Maybe POSIX
- maxSize :: Maybe Int
- autoScalingConfigurationRevision :: Maybe Int
- autoScalingConfigurationArn :: Maybe Text
- minSize :: Maybe Int
- deletedAt :: Maybe POSIX
- latest :: Maybe Bool
- maxConcurrency :: Maybe Int
- newAutoScalingConfiguration :: AutoScalingConfiguration
- autoScalingConfiguration_status :: Lens' AutoScalingConfiguration (Maybe AutoScalingConfigurationStatus)
- autoScalingConfiguration_autoScalingConfigurationName :: Lens' AutoScalingConfiguration (Maybe Text)
- autoScalingConfiguration_createdAt :: Lens' AutoScalingConfiguration (Maybe UTCTime)
- autoScalingConfiguration_maxSize :: Lens' AutoScalingConfiguration (Maybe Int)
- autoScalingConfiguration_autoScalingConfigurationRevision :: Lens' AutoScalingConfiguration (Maybe Int)
- autoScalingConfiguration_autoScalingConfigurationArn :: Lens' AutoScalingConfiguration (Maybe Text)
- autoScalingConfiguration_minSize :: Lens' AutoScalingConfiguration (Maybe Int)
- autoScalingConfiguration_deletedAt :: Lens' AutoScalingConfiguration (Maybe UTCTime)
- autoScalingConfiguration_latest :: Lens' AutoScalingConfiguration (Maybe Bool)
- autoScalingConfiguration_maxConcurrency :: Lens' AutoScalingConfiguration (Maybe Int)
- data AutoScalingConfigurationSummary = AutoScalingConfigurationSummary' {}
- newAutoScalingConfigurationSummary :: AutoScalingConfigurationSummary
- autoScalingConfigurationSummary_autoScalingConfigurationName :: Lens' AutoScalingConfigurationSummary (Maybe Text)
- autoScalingConfigurationSummary_autoScalingConfigurationRevision :: Lens' AutoScalingConfigurationSummary (Maybe Int)
- autoScalingConfigurationSummary_autoScalingConfigurationArn :: Lens' AutoScalingConfigurationSummary (Maybe Text)
- data CertificateValidationRecord = CertificateValidationRecord' {}
- newCertificateValidationRecord :: CertificateValidationRecord
- certificateValidationRecord_status :: Lens' CertificateValidationRecord (Maybe CertificateValidationRecordStatus)
- certificateValidationRecord_value :: Lens' CertificateValidationRecord (Maybe Text)
- certificateValidationRecord_name :: Lens' CertificateValidationRecord (Maybe Text)
- certificateValidationRecord_type :: Lens' CertificateValidationRecord (Maybe Text)
- data CodeConfiguration = CodeConfiguration' {}
- newCodeConfiguration :: ConfigurationSource -> CodeConfiguration
- codeConfiguration_codeConfigurationValues :: Lens' CodeConfiguration (Maybe CodeConfigurationValues)
- codeConfiguration_configurationSource :: Lens' CodeConfiguration ConfigurationSource
- data CodeConfigurationValues = CodeConfigurationValues' {}
- newCodeConfigurationValues :: Runtime -> CodeConfigurationValues
- codeConfigurationValues_startCommand :: Lens' CodeConfigurationValues (Maybe Text)
- codeConfigurationValues_runtimeEnvironmentVariables :: Lens' CodeConfigurationValues (Maybe (HashMap Text Text))
- codeConfigurationValues_buildCommand :: Lens' CodeConfigurationValues (Maybe Text)
- codeConfigurationValues_port :: Lens' CodeConfigurationValues (Maybe Text)
- codeConfigurationValues_runtime :: Lens' CodeConfigurationValues Runtime
- data CodeRepository = CodeRepository' {}
- newCodeRepository :: Text -> SourceCodeVersion -> CodeRepository
- codeRepository_codeConfiguration :: Lens' CodeRepository (Maybe CodeConfiguration)
- codeRepository_repositoryUrl :: Lens' CodeRepository Text
- codeRepository_sourceCodeVersion :: Lens' CodeRepository SourceCodeVersion
- data Connection = Connection' {}
- newConnection :: Connection
- connection_status :: Lens' Connection (Maybe ConnectionStatus)
- connection_createdAt :: Lens' Connection (Maybe UTCTime)
- connection_providerType :: Lens' Connection (Maybe ProviderType)
- connection_connectionName :: Lens' Connection (Maybe Text)
- connection_connectionArn :: Lens' Connection (Maybe Text)
- data ConnectionSummary = ConnectionSummary' {}
- newConnectionSummary :: ConnectionSummary
- connectionSummary_status :: Lens' ConnectionSummary (Maybe ConnectionStatus)
- connectionSummary_createdAt :: Lens' ConnectionSummary (Maybe UTCTime)
- connectionSummary_providerType :: Lens' ConnectionSummary (Maybe ProviderType)
- connectionSummary_connectionName :: Lens' ConnectionSummary (Maybe Text)
- connectionSummary_connectionArn :: Lens' ConnectionSummary (Maybe Text)
- data CustomDomain = CustomDomain' {}
- newCustomDomain :: Text -> Bool -> CustomDomainAssociationStatus -> CustomDomain
- customDomain_certificateValidationRecords :: Lens' CustomDomain (Maybe [CertificateValidationRecord])
- customDomain_domainName :: Lens' CustomDomain Text
- customDomain_enableWWWSubdomain :: Lens' CustomDomain Bool
- customDomain_status :: Lens' CustomDomain CustomDomainAssociationStatus
- data EncryptionConfiguration = EncryptionConfiguration' {}
- newEncryptionConfiguration :: Text -> EncryptionConfiguration
- encryptionConfiguration_kmsKey :: Lens' EncryptionConfiguration Text
- data HealthCheckConfiguration = HealthCheckConfiguration' {}
- newHealthCheckConfiguration :: HealthCheckConfiguration
- healthCheckConfiguration_healthyThreshold :: Lens' HealthCheckConfiguration (Maybe Natural)
- healthCheckConfiguration_path :: Lens' HealthCheckConfiguration (Maybe Text)
- healthCheckConfiguration_protocol :: Lens' HealthCheckConfiguration (Maybe HealthCheckProtocol)
- healthCheckConfiguration_interval :: Lens' HealthCheckConfiguration (Maybe Natural)
- healthCheckConfiguration_timeout :: Lens' HealthCheckConfiguration (Maybe Natural)
- healthCheckConfiguration_unhealthyThreshold :: Lens' HealthCheckConfiguration (Maybe Natural)
- data ImageConfiguration = ImageConfiguration' {}
- newImageConfiguration :: ImageConfiguration
- imageConfiguration_startCommand :: Lens' ImageConfiguration (Maybe Text)
- imageConfiguration_runtimeEnvironmentVariables :: Lens' ImageConfiguration (Maybe (HashMap Text Text))
- imageConfiguration_port :: Lens' ImageConfiguration (Maybe Text)
- data ImageRepository = ImageRepository' {}
- newImageRepository :: Text -> ImageRepositoryType -> ImageRepository
- imageRepository_imageConfiguration :: Lens' ImageRepository (Maybe ImageConfiguration)
- imageRepository_imageIdentifier :: Lens' ImageRepository Text
- imageRepository_imageRepositoryType :: Lens' ImageRepository ImageRepositoryType
- data InstanceConfiguration = InstanceConfiguration' {}
- newInstanceConfiguration :: InstanceConfiguration
- instanceConfiguration_memory :: Lens' InstanceConfiguration (Maybe Text)
- instanceConfiguration_instanceRoleArn :: Lens' InstanceConfiguration (Maybe Text)
- instanceConfiguration_cpu :: Lens' InstanceConfiguration (Maybe Text)
- data OperationSummary = OperationSummary' {}
- newOperationSummary :: OperationSummary
- operationSummary_status :: Lens' OperationSummary (Maybe OperationStatus)
- operationSummary_targetArn :: Lens' OperationSummary (Maybe Text)
- operationSummary_endedAt :: Lens' OperationSummary (Maybe UTCTime)
- operationSummary_startedAt :: Lens' OperationSummary (Maybe UTCTime)
- operationSummary_id :: Lens' OperationSummary (Maybe Text)
- operationSummary_type :: Lens' OperationSummary (Maybe OperationType)
- operationSummary_updatedAt :: Lens' OperationSummary (Maybe UTCTime)
- data Service = Service' {
- encryptionConfiguration :: Maybe EncryptionConfiguration
- healthCheckConfiguration :: Maybe HealthCheckConfiguration
- deletedAt :: Maybe POSIX
- serviceName :: Text
- serviceId :: Text
- serviceArn :: Text
- serviceUrl :: Text
- createdAt :: POSIX
- updatedAt :: POSIX
- status :: ServiceStatus
- sourceConfiguration :: SourceConfiguration
- instanceConfiguration :: InstanceConfiguration
- autoScalingConfigurationSummary :: AutoScalingConfigurationSummary
- newService :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> ServiceStatus -> SourceConfiguration -> InstanceConfiguration -> AutoScalingConfigurationSummary -> Service
- service_encryptionConfiguration :: Lens' Service (Maybe EncryptionConfiguration)
- service_healthCheckConfiguration :: Lens' Service (Maybe HealthCheckConfiguration)
- service_deletedAt :: Lens' Service (Maybe UTCTime)
- service_serviceName :: Lens' Service Text
- service_serviceId :: Lens' Service Text
- service_serviceArn :: Lens' Service Text
- service_serviceUrl :: Lens' Service Text
- service_createdAt :: Lens' Service UTCTime
- service_updatedAt :: Lens' Service UTCTime
- service_status :: Lens' Service ServiceStatus
- service_sourceConfiguration :: Lens' Service SourceConfiguration
- service_instanceConfiguration :: Lens' Service InstanceConfiguration
- service_autoScalingConfigurationSummary :: Lens' Service AutoScalingConfigurationSummary
- data ServiceSummary = ServiceSummary' {}
- newServiceSummary :: ServiceSummary
- serviceSummary_status :: Lens' ServiceSummary (Maybe ServiceStatus)
- serviceSummary_createdAt :: Lens' ServiceSummary (Maybe UTCTime)
- serviceSummary_serviceUrl :: Lens' ServiceSummary (Maybe Text)
- serviceSummary_serviceName :: Lens' ServiceSummary (Maybe Text)
- serviceSummary_updatedAt :: Lens' ServiceSummary (Maybe UTCTime)
- serviceSummary_serviceArn :: Lens' ServiceSummary (Maybe Text)
- serviceSummary_serviceId :: Lens' ServiceSummary (Maybe Text)
- data SourceCodeVersion = SourceCodeVersion' {}
- newSourceCodeVersion :: SourceCodeVersionType -> Text -> SourceCodeVersion
- sourceCodeVersion_type :: Lens' SourceCodeVersion SourceCodeVersionType
- sourceCodeVersion_value :: Lens' SourceCodeVersion Text
- data SourceConfiguration = SourceConfiguration' {}
- newSourceConfiguration :: SourceConfiguration
- sourceConfiguration_imageRepository :: Lens' SourceConfiguration (Maybe ImageRepository)
- sourceConfiguration_codeRepository :: Lens' SourceConfiguration (Maybe CodeRepository)
- sourceConfiguration_autoDeploymentsEnabled :: Lens' SourceConfiguration (Maybe Bool)
- sourceConfiguration_authenticationConfiguration :: Lens' SourceConfiguration (Maybe AuthenticationConfiguration)
- data Tag = Tag' {}
- newTag :: Tag
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2020-05-15 of the Amazon App Runner SDK configuration.
Errors
_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 :: 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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
An unexpected service exception occurred.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't perform this action when the resource is in its current state.
AutoScalingConfigurationStatus
newtype AutoScalingConfigurationStatus Source #
Constructors
| AutoScalingConfigurationStatus' | |
Fields | |
Bundled Patterns
| pattern AutoScalingConfigurationStatus_ACTIVE :: AutoScalingConfigurationStatus | |
| pattern AutoScalingConfigurationStatus_INACTIVE :: AutoScalingConfigurationStatus |
Instances
CertificateValidationRecordStatus
newtype CertificateValidationRecordStatus Source #
Constructors
| CertificateValidationRecordStatus' | |
Bundled Patterns
Instances
ConfigurationSource
newtype ConfigurationSource Source #
Constructors
| ConfigurationSource' | |
Fields | |
Bundled Patterns
| pattern ConfigurationSource_API :: ConfigurationSource | |
| pattern ConfigurationSource_REPOSITORY :: ConfigurationSource |
Instances
ConnectionStatus
newtype ConnectionStatus Source #
Constructors
| ConnectionStatus' | |
Fields | |
Bundled Patterns
| pattern ConnectionStatus_AVAILABLE :: ConnectionStatus | |
| pattern ConnectionStatus_DELETED :: ConnectionStatus | |
| pattern ConnectionStatus_ERROR :: ConnectionStatus | |
| pattern ConnectionStatus_PENDING_HANDSHAKE :: ConnectionStatus |
Instances
CustomDomainAssociationStatus
newtype CustomDomainAssociationStatus Source #
Constructors
| CustomDomainAssociationStatus' | |
Fields | |
Bundled Patterns
Instances
HealthCheckProtocol
newtype HealthCheckProtocol Source #
Constructors
| HealthCheckProtocol' | |
Fields | |
Bundled Patterns
| pattern HealthCheckProtocol_HTTP :: HealthCheckProtocol | |
| pattern HealthCheckProtocol_TCP :: HealthCheckProtocol |
Instances
ImageRepositoryType
newtype ImageRepositoryType Source #
Constructors
| ImageRepositoryType' | |
Fields | |
Bundled Patterns
| pattern ImageRepositoryType_ECR :: ImageRepositoryType | |
| pattern ImageRepositoryType_ECR_PUBLIC :: ImageRepositoryType |
Instances
OperationStatus
newtype OperationStatus Source #
Constructors
| OperationStatus' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| OperationType' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| ProviderType' | |
Fields | |
Bundled Patterns
| pattern ProviderType_GITHUB :: ProviderType |
Instances
Runtime
Constructors
| Runtime' | |
Fields
| |
Bundled Patterns
| pattern Runtime_NODEJS_12 :: Runtime | |
| pattern Runtime_PYTHON_3 :: Runtime |
Instances
ServiceStatus
newtype ServiceStatus Source #
Constructors
| ServiceStatus' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| SourceCodeVersionType' | |
Fields | |
Bundled Patterns
| pattern SourceCodeVersionType_BRANCH :: SourceCodeVersionType |
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.
Constructors
| AuthenticationConfiguration' | |
Fields
| |
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.
authenticationConfiguration_accessRoleArn :: Lens' AuthenticationConfiguration (Maybe Text) Source #
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).
authenticationConfiguration_connectionArn :: Lens' AuthenticationConfiguration (Maybe Text) Source #
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.
Constructors
| AutoScalingConfiguration' | |
Fields
| |
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.
autoScalingConfiguration_status :: Lens' AutoScalingConfiguration (Maybe AutoScalingConfigurationStatus) Source #
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.
autoScalingConfiguration_autoScalingConfigurationName :: Lens' AutoScalingConfiguration (Maybe Text) Source #
The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
autoScalingConfiguration_createdAt :: Lens' AutoScalingConfiguration (Maybe UTCTime) Source #
The time when the auto scaling configuration was created. It's in Unix time stamp format.
autoScalingConfiguration_maxSize :: Lens' AutoScalingConfiguration (Maybe Int) Source #
The maximum number of instances that a service scales up to. At most
MaxSize instances actively serve traffic for your service.
autoScalingConfiguration_autoScalingConfigurationRevision :: Lens' AutoScalingConfiguration (Maybe Int) Source #
The revision of this auto scaling configuration. It's unique among all
the active configurations ("Status": "ACTIVE") that share the same
AutoScalingConfigurationName.
autoScalingConfiguration_autoScalingConfigurationArn :: Lens' AutoScalingConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) of this auto scaling configuration.
autoScalingConfiguration_minSize :: Lens' AutoScalingConfiguration (Maybe Int) Source #
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.
autoScalingConfiguration_deletedAt :: Lens' AutoScalingConfiguration (Maybe UTCTime) Source #
The time when the auto scaling configuration was deleted. It's in Unix time stamp format.
autoScalingConfiguration_latest :: Lens' AutoScalingConfiguration (Maybe Bool) Source #
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.
autoScalingConfiguration_maxConcurrency :: Lens' AutoScalingConfiguration (Maybe Int) Source #
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.
Constructors
| AutoScalingConfigurationSummary' | |
Fields
| |
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.
autoScalingConfigurationSummary_autoScalingConfigurationName :: Lens' AutoScalingConfigurationSummary (Maybe Text) Source #
The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
autoScalingConfigurationSummary_autoScalingConfigurationRevision :: Lens' AutoScalingConfigurationSummary (Maybe Int) Source #
The revision of this auto scaling configuration. It's unique among all
the active configurations ("Status": "ACTIVE") with the same
AutoScalingConfigurationName.
autoScalingConfigurationSummary_autoScalingConfigurationArn :: Lens' AutoScalingConfigurationSummary (Maybe Text) Source #
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.
Constructors
| CertificateValidationRecord' | |
Fields
| |
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.
certificateValidationRecord_status :: Lens' CertificateValidationRecord (Maybe CertificateValidationRecordStatus) Source #
The current state of the certificate CNAME record validation. It should
change to SUCCESS after App Runner completes validation with your DNS.
certificateValidationRecord_value :: Lens' CertificateValidationRecord (Maybe Text) Source #
The certificate CNAME record value.
certificateValidationRecord_name :: Lens' CertificateValidationRecord (Maybe Text) Source #
The certificate CNAME record name.
certificateValidationRecord_type :: Lens' CertificateValidationRecord (Maybe Text) Source #
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.
Constructors
| CodeConfiguration' | |
Fields
| |
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.yamlfile in the source code repository and ignoresCodeConfigurationValues.API– App Runner uses configuration values provided inCodeConfigurationValuesand ignores theapprunner.yamlfile in the source code repository.
codeConfiguration_codeConfigurationValues :: Lens' CodeConfiguration (Maybe CodeConfigurationValues) Source #
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).
codeConfiguration_configurationSource :: Lens' CodeConfiguration ConfigurationSource Source #
The source of the App Runner configuration. Values are interpreted as follows:
REPOSITORY– App Runner reads configuration values from theapprunner.yamlfile in the source code repository and ignoresCodeConfigurationValues.API– App Runner uses configuration values provided inCodeConfigurationValuesand ignores theapprunner.yamlfile 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.
Constructors
| CodeConfigurationValues' | |
Fields
| |
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.
codeConfigurationValues_startCommand :: Lens' CodeConfigurationValues (Maybe Text) Source #
The command App Runner runs to start your application.
codeConfigurationValues_runtimeEnvironmentVariables :: Lens' CodeConfigurationValues (Maybe (HashMap Text Text)) Source #
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.
codeConfigurationValues_buildCommand :: Lens' CodeConfigurationValues (Maybe Text) Source #
The command App Runner runs to build your application.
codeConfigurationValues_port :: Lens' CodeConfigurationValues (Maybe Text) Source #
The port that your application listens to in the container.
Default: 8080
codeConfigurationValues_runtime :: Lens' CodeConfigurationValues Runtime Source #
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.
Constructors
| CodeRepository' | |
Fields
| |
Instances
Arguments
| :: 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.
codeRepository_codeConfiguration :: Lens' CodeRepository (Maybe CodeConfiguration) Source #
Configuration for building and running the service from a source code repository.
codeRepository_repositoryUrl :: Lens' CodeRepository Text Source #
The location of the repository that contains the source code.
codeRepository_sourceCodeVersion :: Lens' CodeRepository SourceCodeVersion Source #
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.
Constructors
| Connection' | |
Fields
| |
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.
connection_status :: Lens' Connection (Maybe ConnectionStatus) Source #
The current state of the App Runner connection. When the state is
AVAILABLE, you can use the connection to create an App Runner service.
connection_createdAt :: Lens' Connection (Maybe UTCTime) Source #
The App Runner connection creation time, expressed as a Unix time stamp.
connection_providerType :: Lens' Connection (Maybe ProviderType) Source #
The source repository provider.
connection_connectionName :: Lens' Connection (Maybe Text) Source #
The customer-provided connection name.
connection_connectionArn :: Lens' Connection (Maybe Text) Source #
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.
Constructors
| ConnectionSummary' | |
Fields
| |
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.
connectionSummary_status :: Lens' ConnectionSummary (Maybe ConnectionStatus) Source #
The current state of the App Runner connection. When the state is
AVAILABLE, you can use the connection to create an App Runner service.
connectionSummary_createdAt :: Lens' ConnectionSummary (Maybe UTCTime) Source #
The App Runner connection creation time, expressed as a Unix time stamp.
connectionSummary_providerType :: Lens' ConnectionSummary (Maybe ProviderType) Source #
The source repository provider.
connectionSummary_connectionName :: Lens' ConnectionSummary (Maybe Text) Source #
The customer-provided connection name.
connectionSummary_connectionArn :: Lens' ConnectionSummary (Maybe Text) Source #
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.
Constructors
| CustomDomain' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Bool | |
| -> CustomDomainAssociationStatus | |
| -> CustomDomain |
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.
customDomain_certificateValidationRecords :: Lens' CustomDomain (Maybe [CertificateValidationRecord]) Source #
A list of certificate CNAME records that's used for this domain name.
customDomain_domainName :: Lens' CustomDomain Text Source #
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).
customDomain_enableWWWSubdomain :: Lens' CustomDomain Bool Source #
When true, the subdomain www.DomainName is associated with the App
Runner service in addition to the base domain.
customDomain_status :: Lens' CustomDomain CustomDomainAssociationStatus Source #
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.
Constructors
| EncryptionConfiguration' | |
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.
encryptionConfiguration_kmsKey :: Lens' EncryptionConfiguration Text Source #
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.
Constructors
| HealthCheckConfiguration' | |
Fields
| |
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
healthCheckConfiguration_healthyThreshold :: Lens' HealthCheckConfiguration (Maybe Natural) Source #
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
healthCheckConfiguration_path :: Lens' HealthCheckConfiguration (Maybe Text) Source #
The URL that health check requests are sent to.
Path is only applicable when you set Protocol to HTTP.
Default: "/"
healthCheckConfiguration_protocol :: Lens' HealthCheckConfiguration (Maybe HealthCheckProtocol) Source #
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
healthCheckConfiguration_interval :: Lens' HealthCheckConfiguration (Maybe Natural) Source #
The time interval, in seconds, between health checks.
Default: 5
healthCheckConfiguration_timeout :: Lens' HealthCheckConfiguration (Maybe Natural) Source #
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
healthCheckConfiguration_unhealthyThreshold :: Lens' HealthCheckConfiguration (Maybe Natural) Source #
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.
Constructors
| ImageConfiguration' | |
Fields
| |
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
imageConfiguration_startCommand :: Lens' ImageConfiguration (Maybe Text) Source #
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.
imageConfiguration_runtimeEnvironmentVariables :: Lens' ImageConfiguration (Maybe (HashMap Text Text)) Source #
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.
imageConfiguration_port :: Lens' ImageConfiguration (Maybe Text) Source #
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.
Constructors
| ImageRepository' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ImageRepositoryType | |
| -> ImageRepository |
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.
imageRepository_imageConfiguration :: Lens' ImageRepository (Maybe ImageConfiguration) Source #
Configuration for running the identified image.
imageRepository_imageIdentifier :: Lens' ImageRepository Text Source #
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.
imageRepository_imageRepositoryType :: Lens' ImageRepository ImageRepositoryType Source #
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.
Constructors
| InstanceConfiguration' | |
Fields
| |
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
instanceConfiguration_memory :: Lens' InstanceConfiguration (Maybe Text) Source #
The amount of memory, in MB or GB, reserved for each instance of your App Runner service.
Default: 2 GB
instanceConfiguration_instanceRoleArn :: Lens' InstanceConfiguration (Maybe Text) Source #
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.
instanceConfiguration_cpu :: Lens' InstanceConfiguration (Maybe Text) Source #
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.
Constructors
| OperationSummary' | |
Fields
| |
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.
operationSummary_status :: Lens' OperationSummary (Maybe OperationStatus) Source #
The current state of the operation.
operationSummary_targetArn :: Lens' OperationSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the resource that the operation acted on (for example, an App Runner service).
operationSummary_endedAt :: Lens' OperationSummary (Maybe UTCTime) Source #
The time when the operation ended. It's in the Unix time stamp format.
operationSummary_startedAt :: Lens' OperationSummary (Maybe UTCTime) Source #
The time when the operation started. It's in the Unix time stamp format.
operationSummary_id :: Lens' OperationSummary (Maybe Text) Source #
A unique ID of this operation. It's unique in the scope of the App Runner service.
operationSummary_type :: Lens' OperationSummary (Maybe OperationType) Source #
The type of operation. It indicates a specific action that occured.
operationSummary_updatedAt :: Lens' OperationSummary (Maybe UTCTime) Source #
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.
Constructors
| Service' | |
Fields
| |
Instances
Arguments
| :: 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.
service_encryptionConfiguration :: Lens' Service (Maybe EncryptionConfiguration) Source #
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.
service_healthCheckConfiguration :: Lens' Service (Maybe HealthCheckConfiguration) Source #
The settings for the health check that App Runner performs to monitor the health of this service.
service_deletedAt :: Lens' Service (Maybe UTCTime) Source #
The time when the App Runner service was deleted. It's in the Unix time stamp format.
service_serviceId :: Lens' Service Text Source #
An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
service_serviceUrl :: Lens' Service Text Source #
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
service_createdAt :: Lens' Service UTCTime Source #
The time when the App Runner service was created. It's in the Unix time stamp format.
service_updatedAt :: Lens' Service UTCTime Source #
The time when the App Runner service was last updated at. It's in the Unix time stamp format.
service_status :: Lens' Service ServiceStatus Source #
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.
service_sourceConfiguration :: Lens' Service SourceConfiguration Source #
The source deployed to the App Runner service. It can be a code or an image repository.
service_instanceConfiguration :: Lens' Service InstanceConfiguration Source #
The runtime configuration of instances (scaling units) of this service.
service_autoScalingConfigurationSummary :: Lens' Service AutoScalingConfigurationSummary Source #
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.
Constructors
| ServiceSummary' | |
Fields
| |
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.
serviceSummary_status :: Lens' ServiceSummary (Maybe ServiceStatus) Source #
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.
serviceSummary_createdAt :: Lens' ServiceSummary (Maybe UTCTime) Source #
The time when the App Runner service was created. It's in the Unix time stamp format.
serviceSummary_serviceUrl :: Lens' ServiceSummary (Maybe Text) Source #
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
serviceSummary_serviceName :: Lens' ServiceSummary (Maybe Text) Source #
The customer-provided service name.
serviceSummary_updatedAt :: Lens' ServiceSummary (Maybe UTCTime) Source #
The time when the App Runner service was last updated. It's in theUnix time stamp format.
serviceSummary_serviceArn :: Lens' ServiceSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of this service.
serviceSummary_serviceId :: Lens' ServiceSummary (Maybe Text) Source #
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.
Constructors
| SourceCodeVersion' | |
Fields
| |
Instances
Arguments
| :: SourceCodeVersionType | |
| -> Text | |
| -> SourceCodeVersion |
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.
sourceCodeVersion_type :: Lens' SourceCodeVersion SourceCodeVersionType Source #
The type of version identifier.
For a git-based repository, branches represent versions.
sourceCodeVersion_value :: Lens' SourceCodeVersion Text Source #
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.
Constructors
| SourceConfiguration' | |
Fields
| |
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.
sourceConfiguration_imageRepository :: Lens' SourceConfiguration (Maybe ImageRepository) Source #
The description of a source image repository.
You must provide either this member or CodeRepository (but not both).
sourceConfiguration_codeRepository :: Lens' SourceConfiguration (Maybe CodeRepository) Source #
The description of a source code repository.
You must provide either this member or ImageRepository (but not both).
sourceConfiguration_autoDeploymentsEnabled :: Lens' SourceConfiguration (Maybe Bool) Source #
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).
sourceConfiguration_authenticationConfiguration :: Lens' SourceConfiguration (Maybe AuthenticationConfiguration) Source #
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.