String serviceArn
The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.
String 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).
Boolean enableWWWSubdomain
Set to true to associate the subdomain www.DomainName with the App Runner
service in addition to the base domain.
Default: true
String dNSTarget
The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.
String serviceArn
The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.
CustomDomain customDomain
A description of the domain name that's being associated.
String 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.
String 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).
String autoScalingConfigurationArn
The Amazon Resource Name (ARN) of this auto scaling configuration.
String autoScalingConfigurationName
The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
Integer autoScalingConfigurationRevision
The revision of this auto scaling configuration. It's unique among all the active configurations (
"Status": "ACTIVE") that share the same AutoScalingConfigurationName.
Boolean 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.
String 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.
Integer 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.
Integer 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.
Integer maxSize
The maximum number of instances that a service scales up to. At most MaxSize instances actively
serve traffic for your service.
Date createdAt
The time when the auto scaling configuration was created. It's in Unix time stamp format.
Date deletedAt
The time when the auto scaling configuration was deleted. It's in Unix time stamp format.
String autoScalingConfigurationArn
The Amazon Resource Name (ARN) of this auto scaling configuration.
String autoScalingConfigurationName
The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
Integer autoScalingConfigurationRevision
The revision of this auto scaling configuration. It's unique among all the active configurations (
"Status": "ACTIVE") with the same AutoScalingConfigurationName.
String name
The certificate CNAME record name.
String type
The record type, always CNAME.
String value
The certificate CNAME record value.
String status
The current state of the certificate CNAME record validation. It should change to SUCCESS after App
Runner completes validation with your DNS.
String configurationSource
The source of the App Runner configuration. Values are interpreted as follows:
REPOSITORY – App Runner reads configuration values from the apprunner.yaml file in the
source code repository and ignores CodeConfigurationValues.
API – App Runner uses configuration values provided in CodeConfigurationValues and
ignores the apprunner.yaml file in the source code repository.
CodeConfigurationValues 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).
String runtime
A runtime environment type for building and running an App Runner service. It represents a programming language runtime.
String buildCommand
The command App Runner runs to build your application.
String startCommand
The command App Runner runs to start your application.
String port
The port that your application listens to in the container.
Default: 8080
Map<K,V> 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.
String repositoryUrl
The location of the repository that contains the source code.
SourceCodeVersion sourceCodeVersion
The version that should be used within the source code repository.
CodeConfiguration codeConfiguration
Configuration for building and running the service from a source code repository.
String connectionName
The customer-provided connection name.
String connectionArn
The Amazon Resource Name (ARN) of this connection.
String providerType
The source repository provider.
String 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.
Date createdAt
The App Runner connection creation time, expressed as a Unix time stamp.
String connectionName
The customer-provided connection name.
String connectionArn
The Amazon Resource Name (ARN) of this connection.
String providerType
The source repository provider.
String 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.
Date createdAt
The App Runner connection creation time, expressed as a Unix time stamp.
String autoScalingConfigurationName
A name for the auto scaling configuration. When you use it for the first time in an AWS 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.
Integer 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
Integer 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
Integer maxSize
The maximum number of instances that your service scales up to. At most MaxSize instances actively
serve traffic for your service.
Default: 25
List<E> tags
A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.
AutoScalingConfiguration autoScalingConfiguration
A description of the App Runner auto scaling configuration that's created by this request.
String connectionName
A name for the new connection. It must be unique across all App Runner connections for the AWS account in the AWS Region.
String providerType
The source repository provider.
List<E> tags
A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.
Connection connection
A description of the App Runner connection that's created by this request.
String serviceName
A name for the new service. It must be unique across all the running App Runner services in your AWS account in the AWS Region.
SourceConfiguration sourceConfiguration
The source to deploy to the App Runner service. It can be a code or an image repository.
InstanceConfiguration instanceConfiguration
The runtime configuration of instances (scaling units) of the App Runner service.
List<E> tags
An optional list of metadata items that you can associate with your service resource. A tag is a key-value pair.
EncryptionConfiguration 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 AWS managed CMK.
HealthCheckConfiguration healthCheckConfiguration
The settings for the health check that AWS App Runner performs to monitor the health of your service.
String 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.
Service service
A description of the App Runner service that's created by this request.
String 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.
String 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).
Boolean enableWWWSubdomain
When true, the subdomain www.DomainName is associated with the App Runner
service in addition to the base domain.
List<E> certificateValidationRecords
A list of certificate CNAME records that's used for this domain name.
String status
The current state of the domain name association.
String 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.
AutoScalingConfiguration autoScalingConfiguration
A description of the App Runner auto scaling configuration that this request just deleted.
String connectionArn
The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.
Connection connection
A description of the App Runner connection that this request just deleted.
String serviceArn
The Amazon Resource Name (ARN) of the App Runner service that you want to delete.
Service service
A description of the App Runner service that this request just deleted.
String 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.
String 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.
AutoScalingConfiguration autoScalingConfiguration
A full description of the App Runner auto scaling configuration that you specified in this request.
String serviceArn
The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.
String 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.
Integer 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.
String dNSTarget
The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.
String serviceArn
The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.
List<E> 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.
String nextToken
The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
String serviceArn
The Amazon Resource Name (ARN) of the App Runner service that you want a description for.
Service service
A full description of the App Runner service that you specified in this request.
String dNSTarget
The App Runner subdomain of the App Runner service. The disassociated custom domain name was mapped to this target name.
String serviceArn
The Amazon Resource Name (ARN) of the App Runner service that a custom domain name is disassociated from.
CustomDomain customDomain
A description of the domain name that's being disassociated.
String kmsKey
The ARN of the KMS key that's used for encryption.
String 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
String path
The URL that health check requests are sent to.
Path is only applicable when you set Protocol to HTTP.
Default: "/"
Integer interval
The time interval, in seconds, between health checks.
Default: 5
Integer timeout
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
Integer healthyThreshold
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 3
Integer unhealthyThreshold
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 3
Map<K,V> 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.
String 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.
String port
The port that your application listens to in the container.
Default: 8080
String 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.
ImageConfiguration imageConfiguration
Configuration for running the identified image.
String imageRepositoryType
The type of the image repository. This reflects the repository provider and whether the repository is private or public.
String cpu
The number of CPU units reserved for each instance of your App Runner service.
Default: 1 vCPU
String memory
The amount of memory, in MB or GB, reserved for each instance of your App Runner service.
Default: 2 GB
String 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 AWS APIs.
String 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.
Boolean 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
Integer 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.
String 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.
List<E> 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.
String nextToken
The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
String connectionName
If specified, only this connection is returned. If not specified, the result isn't filtered by name.
Integer 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.
String 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.
List<E> connectionSummaryList
A list of summary information records for connections. In a paginated request, the request returns up to
MaxResults records for each call.
String nextToken
The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request.
String serviceArn
The Amazon Resource Name (ARN) of the App Runner service that you want a list of operations for.
String 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.
Integer 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.
List<E> operationSummaryList
A list of operation summary information records. In a paginated request, the request returns up to
MaxResults records for each call.
String nextToken
The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
String 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.
Integer 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.
List<E> serviceSummaryList
A list of service summary information records. In a paginated request, the request returns up to
MaxResults records for each call.
String nextToken
The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
String 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.
String id
A unique ID of this operation. It's unique in the scope of the App Runner service.
String type
The type of operation. It indicates a specific action that occured.
String status
The current state of the operation.
String targetArn
The Amazon Resource Name (ARN) of the resource that the operation acted on (for example, an App Runner service).
Date startedAt
The time when the operation started. It's in the Unix time stamp format.
Date endedAt
The time when the operation ended. It's in the Unix time stamp format.
Date updatedAt
The time when the operation was last updated. It's in the Unix time stamp format.
String serviceArn
The Amazon Resource Name (ARN) of the App Runner service that you want to pause.
Service service
A description of the App Runner service that this request just paused.
String 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.
String serviceArn
The Amazon Resource Name (ARN) of the App Runner service that you want to resume.
Service service
A description of the App Runner service that this request just resumed.
String 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.
String serviceName
The customer-provided service name.
String serviceId
An ID that App Runner generated for this service. It's unique within the AWS Region.
String serviceArn
The Amazon Resource Name (ARN) of this service.
String serviceUrl
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
Date createdAt
The time when the App Runner service was created. It's in the Unix time stamp format.
Date updatedAt
The time when the App Runner service was last updated at. It's in the Unix time stamp format.
Date deletedAt
The time when the App Runner service was deleted. It's in the Unix time stamp format.
String 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.
SourceConfiguration sourceConfiguration
The source deployed to the App Runner service. It can be a code or an image repository.
InstanceConfiguration instanceConfiguration
The runtime configuration of instances (scaling units) of this service.
EncryptionConfiguration 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 AWS managed CMK.
HealthCheckConfiguration healthCheckConfiguration
The settings for the health check that App Runner performs to monitor the health of this service.
AutoScalingConfigurationSummary autoScalingConfigurationSummary
Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
String serviceName
The customer-provided service name.
String serviceId
An ID that App Runner generated for this service. It's unique within the AWS Region.
String serviceArn
The Amazon Resource Name (ARN) of this service.
String serviceUrl
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
Date createdAt
The time when the App Runner service was created. It's in the Unix time stamp format.
Date updatedAt
The time when the App Runner service was last updated. It's in theUnix time stamp format.
String 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.
CodeRepository codeRepository
The description of a source code repository.
You must provide either this member or ImageRepository (but not both).
ImageRepository imageRepository
The description of a source image repository.
You must provide either this member or CodeRepository (but not both).
Boolean autoDeploymentsEnabled
If true, continuous integration from the source repository is enabled for the App Runner service.
Each repository change (source code commit or new image version) starts a deployment.
Default: true
AuthenticationConfiguration authenticationConfiguration
Describes the resources that are needed to authenticate access to some source repositories.
String serviceArn
The Amazon Resource Name (ARN) of the App Runner service that you want to manually deploy to.
String 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.
String 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.
List<E> 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.
String serviceArn
The Amazon Resource Name (ARN) of the App Runner service that you want to update.
SourceConfiguration 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.
InstanceConfiguration instanceConfiguration
The runtime configuration to apply to instances (scaling units) of the App Runner service.
String autoScalingConfigurationArn
The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.
HealthCheckConfiguration healthCheckConfiguration
The settings for the health check that AWS App Runner performs to monitor the health of your service.
Service 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.
String 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.
Copyright © 2021. All rights reserved.