2022/10/31 - AWS App Runner - 5 new9 updated api methods
Changes This release adds support for private App Runner services. Services may now be configured to be made private and only accessible from a VPC. The changes include a new VpcIngressConnection resource and several new and modified APIs.
Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_vpc_ingress_connections(
Filter={
'ServiceArn': 'string',
'VpcEndpointId': 'string'
},
MaxResults=123,
NextToken='string'
)
dict
The VPC Ingress Connections to be listed based on either the Service Arn or Vpc Endpoint Id, or both.
ServiceArn (string) --
The Amazon Resource Name (ARN) of a service to filter by.
VpcEndpointId (string) --
The ID of a VPC Endpoint to filter by.
integer
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
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.
dict
Response Syntax
{
'VpcIngressConnectionSummaryList': [
{
'VpcIngressConnectionArn': 'string',
'ServiceArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VpcIngressConnectionSummaryList (list) --
A list of summary information records for VPC Ingress Connections. In a paginated request, the request returns up to MaxResults records for each call.
(dict) --
Provides summary information about an VPC Ingress Connection, which includes its VPC Ingress Connection ARN and its associated Service ARN.
VpcIngressConnectionArn (string) --
The Amazon Resource Name (ARN) of the VPC Ingress Connection.
ServiceArn (string) --
The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.
NextToken (string) --
The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
Create an App Runner VPC Ingress Connection resource. App Runner requires this resource when you want to associate your App Runner service with an Amazon VPC endpoint.
See also: AWS API Documentation
Request Syntax
client.create_vpc_ingress_connection(
ServiceArn='string',
VpcIngressConnectionName='string',
IngressVpcConfiguration={
'VpcId': 'string',
'VpcEndpointId': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
string
[REQUIRED]
A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your Amazon Web Services account in the Amazon Web Services Region.
dict
[REQUIRED]
Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.
VpcId (string) --
The ID of the VPC that is used for the VPC endpoint.
VpcEndpointId (string) --
The ID of the VPC endpoint that your App Runner service connects to.
list
An optional list of metadata items that you can associate with the VPC Ingress Connection resource. A tag is a key-value pair.
(dict) --
Describes a tag that is applied to an App Runner resource. A tag is a metadata item consisting of a key-value pair.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
dict
Response Syntax
{
'VpcIngressConnection': {
'VpcIngressConnectionArn': 'string',
'VpcIngressConnectionName': 'string',
'ServiceArn': 'string',
'Status': 'AVAILABLE'|'PENDING_CREATION'|'PENDING_UPDATE'|'PENDING_DELETION'|'FAILED_CREATION'|'FAILED_UPDATE'|'FAILED_DELETION'|'DELETED',
'AccountId': 'string',
'DomainName': 'string',
'IngressVpcConfiguration': {
'VpcId': 'string',
'VpcEndpointId': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'DeletedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
VpcIngressConnection (dict) --
A description of the App Runner VPC Ingress Connection resource that's created by this request.
VpcIngressConnectionArn (string) --
The Amazon Resource Name (ARN) of the VPC Ingress Connection.
VpcIngressConnectionName (string) --
The customer-provided VPC Ingress Connection name.
ServiceArn (string) --
The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.
Status (string) --
The current status of the VPC Ingress Connection. The VPC Ingress Connection displays one of the following statuses: AVAILABLE, PENDING_CREATION, PENDING_UPDATE, PENDING_DELETION, FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, and DELETED..
AccountId (string) --
The Account Id you use to create the VPC Ingress Connection resource.
DomainName (string) --
The domain name associated with the VPC Ingress Connection resource.
IngressVpcConfiguration (dict) --
Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.
VpcId (string) --
The ID of the VPC that is used for the VPC endpoint.
VpcEndpointId (string) --
The ID of the VPC endpoint that your App Runner service connects to.
CreatedAt (datetime) --
The time when the VPC Ingress Connection was created. It's in the Unix time stamp format.
Type: Timestamp
Required: Yes
DeletedAt (datetime) --
The time when the App Runner service was deleted. It's in the Unix time stamp format.
Type: Timestamp
Required: No
Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service. The VPC Ingress Connection must be in one of the following states to be deleted:
AVAILABLE
FAILED_CREATION
FAILED_UPDATE
FAILED_DELETION
See also: AWS API Documentation
Request Syntax
client.delete_vpc_ingress_connection(
VpcIngressConnectionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want to delete.
dict
Response Syntax
{
'VpcIngressConnection': {
'VpcIngressConnectionArn': 'string',
'VpcIngressConnectionName': 'string',
'ServiceArn': 'string',
'Status': 'AVAILABLE'|'PENDING_CREATION'|'PENDING_UPDATE'|'PENDING_DELETION'|'FAILED_CREATION'|'FAILED_UPDATE'|'FAILED_DELETION'|'DELETED',
'AccountId': 'string',
'DomainName': 'string',
'IngressVpcConfiguration': {
'VpcId': 'string',
'VpcEndpointId': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'DeletedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
VpcIngressConnection (dict) --
A description of the App Runner VPC Ingress Connection that this request just deleted.
VpcIngressConnectionArn (string) --
The Amazon Resource Name (ARN) of the VPC Ingress Connection.
VpcIngressConnectionName (string) --
The customer-provided VPC Ingress Connection name.
ServiceArn (string) --
The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.
Status (string) --
The current status of the VPC Ingress Connection. The VPC Ingress Connection displays one of the following statuses: AVAILABLE, PENDING_CREATION, PENDING_UPDATE, PENDING_DELETION, FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, and DELETED..
AccountId (string) --
The Account Id you use to create the VPC Ingress Connection resource.
DomainName (string) --
The domain name associated with the VPC Ingress Connection resource.
IngressVpcConfiguration (dict) --
Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.
VpcId (string) --
The ID of the VPC that is used for the VPC endpoint.
VpcEndpointId (string) --
The ID of the VPC endpoint that your App Runner service connects to.
CreatedAt (datetime) --
The time when the VPC Ingress Connection was created. It's in the Unix time stamp format.
Type: Timestamp
Required: Yes
DeletedAt (datetime) --
The time when the App Runner service was deleted. It's in the Unix time stamp format.
Type: Timestamp
Required: No
Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated:
AVAILABLE
FAILED_CREATION
FAILED_UPDATE
See also: AWS API Documentation
Request Syntax
client.update_vpc_ingress_connection(
VpcIngressConnectionArn='string',
IngressVpcConfiguration={
'VpcId': 'string',
'VpcEndpointId': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (Arn) for the App Runner VPC Ingress Connection resource that you want to update.
dict
[REQUIRED]
Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to update the VPC Ingress Connection resource.
VpcId (string) --
The ID of the VPC that is used for the VPC endpoint.
VpcEndpointId (string) --
The ID of the VPC endpoint that your App Runner service connects to.
dict
Response Syntax
{
'VpcIngressConnection': {
'VpcIngressConnectionArn': 'string',
'VpcIngressConnectionName': 'string',
'ServiceArn': 'string',
'Status': 'AVAILABLE'|'PENDING_CREATION'|'PENDING_UPDATE'|'PENDING_DELETION'|'FAILED_CREATION'|'FAILED_UPDATE'|'FAILED_DELETION'|'DELETED',
'AccountId': 'string',
'DomainName': 'string',
'IngressVpcConfiguration': {
'VpcId': 'string',
'VpcEndpointId': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'DeletedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
VpcIngressConnection (dict) --
A description of the App Runner VPC Ingress Connection resource that's updated by this request.
VpcIngressConnectionArn (string) --
The Amazon Resource Name (ARN) of the VPC Ingress Connection.
VpcIngressConnectionName (string) --
The customer-provided VPC Ingress Connection name.
ServiceArn (string) --
The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.
Status (string) --
The current status of the VPC Ingress Connection. The VPC Ingress Connection displays one of the following statuses: AVAILABLE, PENDING_CREATION, PENDING_UPDATE, PENDING_DELETION, FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, and DELETED..
AccountId (string) --
The Account Id you use to create the VPC Ingress Connection resource.
DomainName (string) --
The domain name associated with the VPC Ingress Connection resource.
IngressVpcConfiguration (dict) --
Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.
VpcId (string) --
The ID of the VPC that is used for the VPC endpoint.
VpcEndpointId (string) --
The ID of the VPC endpoint that your App Runner service connects to.
CreatedAt (datetime) --
The time when the VPC Ingress Connection was created. It's in the Unix time stamp format.
Type: Timestamp
Required: Yes
DeletedAt (datetime) --
The time when the App Runner service was deleted. It's in the Unix time stamp format.
Type: Timestamp
Required: No
Return a full description of an App Runner VPC Ingress Connection resource.
See also: AWS API Documentation
Request Syntax
client.describe_vpc_ingress_connection(
VpcIngressConnectionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want a description for.
dict
Response Syntax
{
'VpcIngressConnection': {
'VpcIngressConnectionArn': 'string',
'VpcIngressConnectionName': 'string',
'ServiceArn': 'string',
'Status': 'AVAILABLE'|'PENDING_CREATION'|'PENDING_UPDATE'|'PENDING_DELETION'|'FAILED_CREATION'|'FAILED_UPDATE'|'FAILED_DELETION'|'DELETED',
'AccountId': 'string',
'DomainName': 'string',
'IngressVpcConfiguration': {
'VpcId': 'string',
'VpcEndpointId': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'DeletedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
VpcIngressConnection (dict) --
A description of the App Runner VPC Ingress Connection that you specified in this request.
VpcIngressConnectionArn (string) --
The Amazon Resource Name (ARN) of the VPC Ingress Connection.
VpcIngressConnectionName (string) --
The customer-provided VPC Ingress Connection name.
ServiceArn (string) --
The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.
Status (string) --
The current status of the VPC Ingress Connection. The VPC Ingress Connection displays one of the following statuses: AVAILABLE, PENDING_CREATION, PENDING_UPDATE, PENDING_DELETION, FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, and DELETED..
AccountId (string) --
The Account Id you use to create the VPC Ingress Connection resource.
DomainName (string) --
The domain name associated with the VPC Ingress Connection resource.
IngressVpcConfiguration (dict) --
Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.
VpcId (string) --
The ID of the VPC that is used for the VPC endpoint.
VpcEndpointId (string) --
The ID of the VPC endpoint that your App Runner service connects to.
CreatedAt (datetime) --
The time when the VPC Ingress Connection was created. It's in the Unix time stamp format.
Type: Timestamp
Required: Yes
DeletedAt (datetime) --
The time when the App Runner service was deleted. It's in the Unix time stamp format.
Type: Timestamp
Required: No
{'VpcDNSTargets': [{'DomainName': 'string',
'VpcId': 'string',
'VpcIngressConnectionArn': 'string'}]}
Associate your own domain name with the App Runner subdomain URL of your App Runner service.
After you call AssociateCustomDomain and receive a successful response, use the information in the CustomDomain record that's returned to add CNAME records to your Domain Name System (DNS). For each mapped domain name, add a mapping to the target App Runner subdomain and one or more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name that you associated. App Runner tracks domain validity in a certificate stored in AWS Certificate Manager (ACM).
See also: AWS API Documentation
Request Syntax
client.associate_custom_domain(
ServiceArn='string',
DomainName='string',
EnableWWWSubdomain=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.
string
[REQUIRED]
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
Set to true to associate the subdomain www.DomainName with the App Runner service in addition to the base domain.
Default: true
dict
Response Syntax
{
'DNSTarget': 'string',
'ServiceArn': 'string',
'CustomDomain': {
'DomainName': 'string',
'EnableWWWSubdomain': True|False,
'CertificateValidationRecords': [
{
'Name': 'string',
'Type': 'string',
'Value': 'string',
'Status': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED'
},
],
'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETE_FAILED'|'PENDING_CERTIFICATE_DNS_VALIDATION'|'BINDING_CERTIFICATE'
},
'VpcDNSTargets': [
{
'VpcIngressConnectionArn': 'string',
'VpcId': 'string',
'DomainName': 'string'
},
]
}
Response Structure
(dict) --
DNSTarget (string) --
The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.
ServiceArn (string) --
The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.
CustomDomain (dict) --
A description of the domain name that's being associated.
DomainName (string) --
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).
EnableWWWSubdomain (boolean) --
When true, the subdomain www.DomainName is associated with the App Runner service in addition to the base domain.
CertificateValidationRecords (list) --
A list of certificate CNAME records that's used for this domain name.
(dict) --
Describes a certificate CNAME record to add to your DNS. For more information, see AssociateCustomDomain.
Name (string) --
The certificate CNAME record name.
Type (string) --
The record type, always CNAME.
Value (string) --
The certificate CNAME record value.
Status (string) --
The current state of the certificate CNAME record validation. It should change to SUCCESS after App Runner completes validation with your DNS.
Status (string) --
The current state of the domain name association.
VpcDNSTargets (list) --
DNS Target records for the custom domains of this Amazon VPC.
(dict) --
DNS Target record for a custom domain of this Amazon VPC.
VpcIngressConnectionArn (string) --
The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated with your service.
VpcId (string) --
The ID of the Amazon VPC that is associated with the custom domain name of the target DNS.
DomainName (string) --
The domain name of your target DNS that is associated with the Amazon VPC.
{'NetworkConfiguration': {'IngressConfiguration': {'IsPubliclyAccessible': 'boolean'}}}
Response {'Service': {'NetworkConfiguration': {'IngressConfiguration': {'IsPubliclyAccessible': 'boolean'}}}}
Create an App Runner service. After the service is created, the action also automatically starts a deployment.
This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.
See also: AWS API Documentation
Request Syntax
client.create_service(
ServiceName='string',
SourceConfiguration={
'CodeRepository': {
'RepositoryUrl': 'string',
'SourceCodeVersion': {
'Type': 'BRANCH',
'Value': 'string'
},
'CodeConfiguration': {
'ConfigurationSource': 'REPOSITORY'|'API',
'CodeConfigurationValues': {
'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
'BuildCommand': 'string',
'StartCommand': 'string',
'Port': 'string',
'RuntimeEnvironmentVariables': {
'string': 'string'
}
}
}
},
'ImageRepository': {
'ImageIdentifier': 'string',
'ImageConfiguration': {
'RuntimeEnvironmentVariables': {
'string': 'string'
},
'StartCommand': 'string',
'Port': 'string'
},
'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
},
'AutoDeploymentsEnabled': True|False,
'AuthenticationConfiguration': {
'ConnectionArn': 'string',
'AccessRoleArn': 'string'
}
},
InstanceConfiguration={
'Cpu': 'string',
'Memory': 'string',
'InstanceRoleArn': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
EncryptionConfiguration={
'KmsKey': 'string'
},
HealthCheckConfiguration={
'Protocol': 'TCP'|'HTTP',
'Path': 'string',
'Interval': 123,
'Timeout': 123,
'HealthyThreshold': 123,
'UnhealthyThreshold': 123
},
AutoScalingConfigurationArn='string',
NetworkConfiguration={
'EgressConfiguration': {
'EgressType': 'DEFAULT'|'VPC',
'VpcConnectorArn': 'string'
},
'IngressConfiguration': {
'IsPubliclyAccessible': True|False
}
},
ObservabilityConfiguration={
'ObservabilityEnabled': True|False,
'ObservabilityConfigurationArn': 'string'
}
)
string
[REQUIRED]
A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.
dict
[REQUIRED]
The source to deploy to the App Runner service. It can be a code or an image repository.
CodeRepository (dict) --
The description of a source code repository.
You must provide either this member or ImageRepository (but not both).
RepositoryUrl (string) -- [REQUIRED]
The location of the repository that contains the source code.
SourceCodeVersion (dict) -- [REQUIRED]
The version that should be used within the source code repository.
Type (string) -- [REQUIRED]
The type of version identifier.
For a git-based repository, branches represent versions.
Value (string) -- [REQUIRED]
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.
CodeConfiguration (dict) --
Configuration for building and running the service from a source code repository.
ConfigurationSource (string) -- [REQUIRED]
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 (dict) --
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).
Runtime (string) -- [REQUIRED]
A runtime environment type for building and running an App Runner service. It represents a programming language runtime.
BuildCommand (string) --
The command App Runner runs to build your application.
StartCommand (string) --
The command App Runner runs to start your application.
Port (string) --
The port that your application listens to in the container.
Default: 8080
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
ImageRepository (dict) --
The description of a source image repository.
You must provide either this member or CodeRepository (but not both).
ImageIdentifier (string) -- [REQUIRED]
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 (dict) --
Configuration for running the identified image.
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
StartCommand (string) --
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.
Port (string) --
The port that your application listens to in the container.
Default: 8080
ImageRepositoryType (string) -- [REQUIRED]
The type of the image repository. This reflects the repository provider and whether the repository is private or public.
AutoDeploymentsEnabled (boolean) --
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).
AuthenticationConfiguration (dict) --
Describes the resources that are needed to authenticate access to some source repositories.
ConnectionArn (string) --
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.
AccessRoleArn (string) --
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).
dict
The runtime configuration of instances (scaling units) of your service.
Cpu (string) --
The number of CPU units reserved for each instance of your App Runner service.
Default: 1 vCPU
Memory (string) --
The amount of memory, in MB or GB, reserved for each instance of your App Runner service.
Default: 2 GB
InstanceRoleArn (string) --
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.
list
An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.
(dict) --
Describes a tag that is applied to an App Runner resource. A tag is a metadata item consisting of a key-value pair.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
dict
An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses an Amazon Web Services managed key.
KmsKey (string) -- [REQUIRED]
The ARN of the KMS key that's used for encryption.
dict
The settings for the health check that App Runner performs to monitor the health of the App Runner service.
Protocol (string) --
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
Path (string) --
The URL that health check requests are sent to.
Path is only applicable when you set Protocol to HTTP.
Default: "/"
Interval (integer) --
The time interval, in seconds, between health checks.
Default: 5
Timeout (integer) --
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
HealthyThreshold (integer) --
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
UnhealthyThreshold (integer) --
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 5
string
The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration.
Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3
Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability
dict
Configuration settings related to network traffic of the web application that the App Runner service runs.
EgressConfiguration (dict) --
Network configuration settings for outbound message traffic.
EgressType (string) --
The type of egress configuration.
Set to DEFAULT for access to resources hosted on public networks.
Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.
VpcConnectorArn (string) --
The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.
IngressConfiguration (dict) --
Network configuration settings for inbound message traffic.
IsPubliclyAccessible (boolean) --
Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.
dict
The observability configuration of your service.
ObservabilityEnabled (boolean) -- [REQUIRED]
When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.
ObservabilityConfigurationArn (string) --
The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.
Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3
Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing
dict
Response Syntax
{
'Service': {
'ServiceName': 'string',
'ServiceId': 'string',
'ServiceArn': 'string',
'ServiceUrl': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'DeletedAt': datetime(2015, 1, 1),
'Status': 'CREATE_FAILED'|'RUNNING'|'DELETED'|'DELETE_FAILED'|'PAUSED'|'OPERATION_IN_PROGRESS',
'SourceConfiguration': {
'CodeRepository': {
'RepositoryUrl': 'string',
'SourceCodeVersion': {
'Type': 'BRANCH',
'Value': 'string'
},
'CodeConfiguration': {
'ConfigurationSource': 'REPOSITORY'|'API',
'CodeConfigurationValues': {
'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
'BuildCommand': 'string',
'StartCommand': 'string',
'Port': 'string',
'RuntimeEnvironmentVariables': {
'string': 'string'
}
}
}
},
'ImageRepository': {
'ImageIdentifier': 'string',
'ImageConfiguration': {
'RuntimeEnvironmentVariables': {
'string': 'string'
},
'StartCommand': 'string',
'Port': 'string'
},
'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
},
'AutoDeploymentsEnabled': True|False,
'AuthenticationConfiguration': {
'ConnectionArn': 'string',
'AccessRoleArn': 'string'
}
},
'InstanceConfiguration': {
'Cpu': 'string',
'Memory': 'string',
'InstanceRoleArn': 'string'
},
'EncryptionConfiguration': {
'KmsKey': 'string'
},
'HealthCheckConfiguration': {
'Protocol': 'TCP'|'HTTP',
'Path': 'string',
'Interval': 123,
'Timeout': 123,
'HealthyThreshold': 123,
'UnhealthyThreshold': 123
},
'AutoScalingConfigurationSummary': {
'AutoScalingConfigurationArn': 'string',
'AutoScalingConfigurationName': 'string',
'AutoScalingConfigurationRevision': 123
},
'NetworkConfiguration': {
'EgressConfiguration': {
'EgressType': 'DEFAULT'|'VPC',
'VpcConnectorArn': 'string'
},
'IngressConfiguration': {
'IsPubliclyAccessible': True|False
}
},
'ObservabilityConfiguration': {
'ObservabilityEnabled': True|False,
'ObservabilityConfigurationArn': 'string'
}
},
'OperationId': 'string'
}
Response Structure
(dict) --
Service (dict) --
A description of the App Runner service that's created by this request.
ServiceName (string) --
The customer-provided service name.
ServiceId (string) --
An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
ServiceArn (string) --
The Amazon Resource Name (ARN) of this service.
ServiceUrl (string) --
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
CreatedAt (datetime) --
The time when the App Runner service was created. It's in the Unix time stamp format.
UpdatedAt (datetime) --
The time when the App Runner service was last updated at. It's in the Unix time stamp format.
DeletedAt (datetime) --
The time when the App Runner service was deleted. It's in the Unix time stamp format.
Status (string) --
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 (dict) --
The source deployed to the App Runner service. It can be a code or an image repository.
CodeRepository (dict) --
The description of a source code repository.
You must provide either this member or ImageRepository (but not both).
RepositoryUrl (string) --
The location of the repository that contains the source code.
SourceCodeVersion (dict) --
The version that should be used within the source code repository.
Type (string) --
The type of version identifier.
For a git-based repository, branches represent versions.
Value (string) --
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.
CodeConfiguration (dict) --
Configuration for building and running the service from a source code repository.
ConfigurationSource (string) --
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 (dict) --
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).
Runtime (string) --
A runtime environment type for building and running an App Runner service. It represents a programming language runtime.
BuildCommand (string) --
The command App Runner runs to build your application.
StartCommand (string) --
The command App Runner runs to start your application.
Port (string) --
The port that your application listens to in the container.
Default: 8080
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
ImageRepository (dict) --
The description of a source image repository.
You must provide either this member or CodeRepository (but not both).
ImageIdentifier (string) --
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 (dict) --
Configuration for running the identified image.
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
StartCommand (string) --
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.
Port (string) --
The port that your application listens to in the container.
Default: 8080
ImageRepositoryType (string) --
The type of the image repository. This reflects the repository provider and whether the repository is private or public.
AutoDeploymentsEnabled (boolean) --
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).
AuthenticationConfiguration (dict) --
Describes the resources that are needed to authenticate access to some source repositories.
ConnectionArn (string) --
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.
AccessRoleArn (string) --
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).
InstanceConfiguration (dict) --
The runtime configuration of instances (scaling units) of this service.
Cpu (string) --
The number of CPU units reserved for each instance of your App Runner service.
Default: 1 vCPU
Memory (string) --
The amount of memory, in MB or GB, reserved for each instance of your App Runner service.
Default: 2 GB
InstanceRoleArn (string) --
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.
EncryptionConfiguration (dict) --
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 key.
KmsKey (string) --
The ARN of the KMS key that's used for encryption.
HealthCheckConfiguration (dict) --
The settings for the health check that App Runner performs to monitor the health of this service.
Protocol (string) --
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
Path (string) --
The URL that health check requests are sent to.
Path is only applicable when you set Protocol to HTTP.
Default: "/"
Interval (integer) --
The time interval, in seconds, between health checks.
Default: 5
Timeout (integer) --
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
HealthyThreshold (integer) --
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
UnhealthyThreshold (integer) --
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 5
AutoScalingConfigurationSummary (dict) --
Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
AutoScalingConfigurationArn (string) --
The Amazon Resource Name (ARN) of this auto scaling configuration.
AutoScalingConfigurationName (string) --
The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
AutoScalingConfigurationRevision (integer) --
The revision of this auto scaling configuration. It's unique among all the active configurations ( "Status": "ACTIVE") with the same AutoScalingConfigurationName.
NetworkConfiguration (dict) --
Configuration settings related to network traffic of the web application that this service runs.
EgressConfiguration (dict) --
Network configuration settings for outbound message traffic.
EgressType (string) --
The type of egress configuration.
Set to DEFAULT for access to resources hosted on public networks.
Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.
VpcConnectorArn (string) --
The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.
IngressConfiguration (dict) --
Network configuration settings for inbound message traffic.
IsPubliclyAccessible (boolean) --
Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.
ObservabilityConfiguration (dict) --
The observability configuration of this service.
ObservabilityEnabled (boolean) --
When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.
ObservabilityConfigurationArn (string) --
The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.
Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3
Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing
OperationId (string) --
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.
{'Service': {'NetworkConfiguration': {'IngressConfiguration': {'IsPubliclyAccessible': 'boolean'}}}}
Delete an App Runner service.
This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.
See also: AWS API Documentation
Request Syntax
client.delete_service(
ServiceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the App Runner service that you want to delete.
dict
Response Syntax
{
'Service': {
'ServiceName': 'string',
'ServiceId': 'string',
'ServiceArn': 'string',
'ServiceUrl': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'DeletedAt': datetime(2015, 1, 1),
'Status': 'CREATE_FAILED'|'RUNNING'|'DELETED'|'DELETE_FAILED'|'PAUSED'|'OPERATION_IN_PROGRESS',
'SourceConfiguration': {
'CodeRepository': {
'RepositoryUrl': 'string',
'SourceCodeVersion': {
'Type': 'BRANCH',
'Value': 'string'
},
'CodeConfiguration': {
'ConfigurationSource': 'REPOSITORY'|'API',
'CodeConfigurationValues': {
'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
'BuildCommand': 'string',
'StartCommand': 'string',
'Port': 'string',
'RuntimeEnvironmentVariables': {
'string': 'string'
}
}
}
},
'ImageRepository': {
'ImageIdentifier': 'string',
'ImageConfiguration': {
'RuntimeEnvironmentVariables': {
'string': 'string'
},
'StartCommand': 'string',
'Port': 'string'
},
'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
},
'AutoDeploymentsEnabled': True|False,
'AuthenticationConfiguration': {
'ConnectionArn': 'string',
'AccessRoleArn': 'string'
}
},
'InstanceConfiguration': {
'Cpu': 'string',
'Memory': 'string',
'InstanceRoleArn': 'string'
},
'EncryptionConfiguration': {
'KmsKey': 'string'
},
'HealthCheckConfiguration': {
'Protocol': 'TCP'|'HTTP',
'Path': 'string',
'Interval': 123,
'Timeout': 123,
'HealthyThreshold': 123,
'UnhealthyThreshold': 123
},
'AutoScalingConfigurationSummary': {
'AutoScalingConfigurationArn': 'string',
'AutoScalingConfigurationName': 'string',
'AutoScalingConfigurationRevision': 123
},
'NetworkConfiguration': {
'EgressConfiguration': {
'EgressType': 'DEFAULT'|'VPC',
'VpcConnectorArn': 'string'
},
'IngressConfiguration': {
'IsPubliclyAccessible': True|False
}
},
'ObservabilityConfiguration': {
'ObservabilityEnabled': True|False,
'ObservabilityConfigurationArn': 'string'
}
},
'OperationId': 'string'
}
Response Structure
(dict) --
Service (dict) --
A description of the App Runner service that this request just deleted.
ServiceName (string) --
The customer-provided service name.
ServiceId (string) --
An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
ServiceArn (string) --
The Amazon Resource Name (ARN) of this service.
ServiceUrl (string) --
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
CreatedAt (datetime) --
The time when the App Runner service was created. It's in the Unix time stamp format.
UpdatedAt (datetime) --
The time when the App Runner service was last updated at. It's in the Unix time stamp format.
DeletedAt (datetime) --
The time when the App Runner service was deleted. It's in the Unix time stamp format.
Status (string) --
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 (dict) --
The source deployed to the App Runner service. It can be a code or an image repository.
CodeRepository (dict) --
The description of a source code repository.
You must provide either this member or ImageRepository (but not both).
RepositoryUrl (string) --
The location of the repository that contains the source code.
SourceCodeVersion (dict) --
The version that should be used within the source code repository.
Type (string) --
The type of version identifier.
For a git-based repository, branches represent versions.
Value (string) --
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.
CodeConfiguration (dict) --
Configuration for building and running the service from a source code repository.
ConfigurationSource (string) --
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 (dict) --
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).
Runtime (string) --
A runtime environment type for building and running an App Runner service. It represents a programming language runtime.
BuildCommand (string) --
The command App Runner runs to build your application.
StartCommand (string) --
The command App Runner runs to start your application.
Port (string) --
The port that your application listens to in the container.
Default: 8080
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
ImageRepository (dict) --
The description of a source image repository.
You must provide either this member or CodeRepository (but not both).
ImageIdentifier (string) --
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 (dict) --
Configuration for running the identified image.
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
StartCommand (string) --
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.
Port (string) --
The port that your application listens to in the container.
Default: 8080
ImageRepositoryType (string) --
The type of the image repository. This reflects the repository provider and whether the repository is private or public.
AutoDeploymentsEnabled (boolean) --
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).
AuthenticationConfiguration (dict) --
Describes the resources that are needed to authenticate access to some source repositories.
ConnectionArn (string) --
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.
AccessRoleArn (string) --
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).
InstanceConfiguration (dict) --
The runtime configuration of instances (scaling units) of this service.
Cpu (string) --
The number of CPU units reserved for each instance of your App Runner service.
Default: 1 vCPU
Memory (string) --
The amount of memory, in MB or GB, reserved for each instance of your App Runner service.
Default: 2 GB
InstanceRoleArn (string) --
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.
EncryptionConfiguration (dict) --
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 key.
KmsKey (string) --
The ARN of the KMS key that's used for encryption.
HealthCheckConfiguration (dict) --
The settings for the health check that App Runner performs to monitor the health of this service.
Protocol (string) --
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
Path (string) --
The URL that health check requests are sent to.
Path is only applicable when you set Protocol to HTTP.
Default: "/"
Interval (integer) --
The time interval, in seconds, between health checks.
Default: 5
Timeout (integer) --
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
HealthyThreshold (integer) --
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
UnhealthyThreshold (integer) --
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 5
AutoScalingConfigurationSummary (dict) --
Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
AutoScalingConfigurationArn (string) --
The Amazon Resource Name (ARN) of this auto scaling configuration.
AutoScalingConfigurationName (string) --
The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
AutoScalingConfigurationRevision (integer) --
The revision of this auto scaling configuration. It's unique among all the active configurations ( "Status": "ACTIVE") with the same AutoScalingConfigurationName.
NetworkConfiguration (dict) --
Configuration settings related to network traffic of the web application that this service runs.
EgressConfiguration (dict) --
Network configuration settings for outbound message traffic.
EgressType (string) --
The type of egress configuration.
Set to DEFAULT for access to resources hosted on public networks.
Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.
VpcConnectorArn (string) --
The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.
IngressConfiguration (dict) --
Network configuration settings for inbound message traffic.
IsPubliclyAccessible (boolean) --
Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.
ObservabilityConfiguration (dict) --
The observability configuration of this service.
ObservabilityEnabled (boolean) --
When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.
ObservabilityConfigurationArn (string) --
The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.
Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3
Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing
OperationId (string) --
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.
{'VpcDNSTargets': [{'DomainName': 'string',
'VpcId': 'string',
'VpcIngressConnectionArn': 'string'}]}
Return a description of custom domain names that are associated with an App Runner service.
See also: AWS API Documentation
Request Syntax
client.describe_custom_domains(
ServiceArn='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.
string
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
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.
dict
Response Syntax
{
'DNSTarget': 'string',
'ServiceArn': 'string',
'CustomDomains': [
{
'DomainName': 'string',
'EnableWWWSubdomain': True|False,
'CertificateValidationRecords': [
{
'Name': 'string',
'Type': 'string',
'Value': 'string',
'Status': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED'
},
],
'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETE_FAILED'|'PENDING_CERTIFICATE_DNS_VALIDATION'|'BINDING_CERTIFICATE'
},
],
'VpcDNSTargets': [
{
'VpcIngressConnectionArn': 'string',
'VpcId': 'string',
'DomainName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DNSTarget (string) --
The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.
ServiceArn (string) --
The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.
CustomDomains (list) --
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.
(dict) --
Describes a custom domain that's associated with an App Runner service.
DomainName (string) --
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).
EnableWWWSubdomain (boolean) --
When true, the subdomain www.DomainName is associated with the App Runner service in addition to the base domain.
CertificateValidationRecords (list) --
A list of certificate CNAME records that's used for this domain name.
(dict) --
Describes a certificate CNAME record to add to your DNS. For more information, see AssociateCustomDomain.
Name (string) --
The certificate CNAME record name.
Type (string) --
The record type, always CNAME.
Value (string) --
The certificate CNAME record value.
Status (string) --
The current state of the certificate CNAME record validation. It should change to SUCCESS after App Runner completes validation with your DNS.
Status (string) --
The current state of the domain name association.
VpcDNSTargets (list) --
DNS Target records for the custom domains of this Amazon VPC.
(dict) --
DNS Target record for a custom domain of this Amazon VPC.
VpcIngressConnectionArn (string) --
The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated with your service.
VpcId (string) --
The ID of the Amazon VPC that is associated with the custom domain name of the target DNS.
DomainName (string) --
The domain name of your target DNS that is associated with the Amazon VPC.
NextToken (string) --
The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
{'Service': {'NetworkConfiguration': {'IngressConfiguration': {'IsPubliclyAccessible': 'boolean'}}}}
Return a full description of an App Runner service.
See also: AWS API Documentation
Request Syntax
client.describe_service(
ServiceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the App Runner service that you want a description for.
dict
Response Syntax
{
'Service': {
'ServiceName': 'string',
'ServiceId': 'string',
'ServiceArn': 'string',
'ServiceUrl': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'DeletedAt': datetime(2015, 1, 1),
'Status': 'CREATE_FAILED'|'RUNNING'|'DELETED'|'DELETE_FAILED'|'PAUSED'|'OPERATION_IN_PROGRESS',
'SourceConfiguration': {
'CodeRepository': {
'RepositoryUrl': 'string',
'SourceCodeVersion': {
'Type': 'BRANCH',
'Value': 'string'
},
'CodeConfiguration': {
'ConfigurationSource': 'REPOSITORY'|'API',
'CodeConfigurationValues': {
'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
'BuildCommand': 'string',
'StartCommand': 'string',
'Port': 'string',
'RuntimeEnvironmentVariables': {
'string': 'string'
}
}
}
},
'ImageRepository': {
'ImageIdentifier': 'string',
'ImageConfiguration': {
'RuntimeEnvironmentVariables': {
'string': 'string'
},
'StartCommand': 'string',
'Port': 'string'
},
'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
},
'AutoDeploymentsEnabled': True|False,
'AuthenticationConfiguration': {
'ConnectionArn': 'string',
'AccessRoleArn': 'string'
}
},
'InstanceConfiguration': {
'Cpu': 'string',
'Memory': 'string',
'InstanceRoleArn': 'string'
},
'EncryptionConfiguration': {
'KmsKey': 'string'
},
'HealthCheckConfiguration': {
'Protocol': 'TCP'|'HTTP',
'Path': 'string',
'Interval': 123,
'Timeout': 123,
'HealthyThreshold': 123,
'UnhealthyThreshold': 123
},
'AutoScalingConfigurationSummary': {
'AutoScalingConfigurationArn': 'string',
'AutoScalingConfigurationName': 'string',
'AutoScalingConfigurationRevision': 123
},
'NetworkConfiguration': {
'EgressConfiguration': {
'EgressType': 'DEFAULT'|'VPC',
'VpcConnectorArn': 'string'
},
'IngressConfiguration': {
'IsPubliclyAccessible': True|False
}
},
'ObservabilityConfiguration': {
'ObservabilityEnabled': True|False,
'ObservabilityConfigurationArn': 'string'
}
}
}
Response Structure
(dict) --
Service (dict) --
A full description of the App Runner service that you specified in this request.
ServiceName (string) --
The customer-provided service name.
ServiceId (string) --
An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
ServiceArn (string) --
The Amazon Resource Name (ARN) of this service.
ServiceUrl (string) --
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
CreatedAt (datetime) --
The time when the App Runner service was created. It's in the Unix time stamp format.
UpdatedAt (datetime) --
The time when the App Runner service was last updated at. It's in the Unix time stamp format.
DeletedAt (datetime) --
The time when the App Runner service was deleted. It's in the Unix time stamp format.
Status (string) --
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 (dict) --
The source deployed to the App Runner service. It can be a code or an image repository.
CodeRepository (dict) --
The description of a source code repository.
You must provide either this member or ImageRepository (but not both).
RepositoryUrl (string) --
The location of the repository that contains the source code.
SourceCodeVersion (dict) --
The version that should be used within the source code repository.
Type (string) --
The type of version identifier.
For a git-based repository, branches represent versions.
Value (string) --
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.
CodeConfiguration (dict) --
Configuration for building and running the service from a source code repository.
ConfigurationSource (string) --
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 (dict) --
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).
Runtime (string) --
A runtime environment type for building and running an App Runner service. It represents a programming language runtime.
BuildCommand (string) --
The command App Runner runs to build your application.
StartCommand (string) --
The command App Runner runs to start your application.
Port (string) --
The port that your application listens to in the container.
Default: 8080
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
ImageRepository (dict) --
The description of a source image repository.
You must provide either this member or CodeRepository (but not both).
ImageIdentifier (string) --
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 (dict) --
Configuration for running the identified image.
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
StartCommand (string) --
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.
Port (string) --
The port that your application listens to in the container.
Default: 8080
ImageRepositoryType (string) --
The type of the image repository. This reflects the repository provider and whether the repository is private or public.
AutoDeploymentsEnabled (boolean) --
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).
AuthenticationConfiguration (dict) --
Describes the resources that are needed to authenticate access to some source repositories.
ConnectionArn (string) --
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.
AccessRoleArn (string) --
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).
InstanceConfiguration (dict) --
The runtime configuration of instances (scaling units) of this service.
Cpu (string) --
The number of CPU units reserved for each instance of your App Runner service.
Default: 1 vCPU
Memory (string) --
The amount of memory, in MB or GB, reserved for each instance of your App Runner service.
Default: 2 GB
InstanceRoleArn (string) --
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.
EncryptionConfiguration (dict) --
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 key.
KmsKey (string) --
The ARN of the KMS key that's used for encryption.
HealthCheckConfiguration (dict) --
The settings for the health check that App Runner performs to monitor the health of this service.
Protocol (string) --
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
Path (string) --
The URL that health check requests are sent to.
Path is only applicable when you set Protocol to HTTP.
Default: "/"
Interval (integer) --
The time interval, in seconds, between health checks.
Default: 5
Timeout (integer) --
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
HealthyThreshold (integer) --
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
UnhealthyThreshold (integer) --
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 5
AutoScalingConfigurationSummary (dict) --
Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
AutoScalingConfigurationArn (string) --
The Amazon Resource Name (ARN) of this auto scaling configuration.
AutoScalingConfigurationName (string) --
The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
AutoScalingConfigurationRevision (integer) --
The revision of this auto scaling configuration. It's unique among all the active configurations ( "Status": "ACTIVE") with the same AutoScalingConfigurationName.
NetworkConfiguration (dict) --
Configuration settings related to network traffic of the web application that this service runs.
EgressConfiguration (dict) --
Network configuration settings for outbound message traffic.
EgressType (string) --
The type of egress configuration.
Set to DEFAULT for access to resources hosted on public networks.
Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.
VpcConnectorArn (string) --
The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.
IngressConfiguration (dict) --
Network configuration settings for inbound message traffic.
IsPubliclyAccessible (boolean) --
Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.
ObservabilityConfiguration (dict) --
The observability configuration of this service.
ObservabilityEnabled (boolean) --
When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.
ObservabilityConfigurationArn (string) --
The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.
Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3
Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing
{'VpcDNSTargets': [{'DomainName': 'string',
'VpcId': 'string',
'VpcIngressConnectionArn': 'string'}]}
Disassociate a custom domain name from an App Runner service.
Certificates tracking domain validity are associated with a custom domain and are stored in AWS Certificate Manager (ACM). These certificates aren't deleted as part of this action. App Runner delays certificate deletion for 30 days after a domain is disassociated from your service.
See also: AWS API Documentation
Request Syntax
client.disassociate_custom_domain(
ServiceArn='string',
DomainName='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from.
string
[REQUIRED]
The domain name that you want to disassociate from the App Runner service.
dict
Response Syntax
{
'DNSTarget': 'string',
'ServiceArn': 'string',
'CustomDomain': {
'DomainName': 'string',
'EnableWWWSubdomain': True|False,
'CertificateValidationRecords': [
{
'Name': 'string',
'Type': 'string',
'Value': 'string',
'Status': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED'
},
],
'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETE_FAILED'|'PENDING_CERTIFICATE_DNS_VALIDATION'|'BINDING_CERTIFICATE'
},
'VpcDNSTargets': [
{
'VpcIngressConnectionArn': 'string',
'VpcId': 'string',
'DomainName': 'string'
},
]
}
Response Structure
(dict) --
DNSTarget (string) --
The App Runner subdomain of the App Runner service. The disassociated custom domain name was mapped to this target name.
ServiceArn (string) --
The Amazon Resource Name (ARN) of the App Runner service that a custom domain name is disassociated from.
CustomDomain (dict) --
A description of the domain name that's being disassociated.
DomainName (string) --
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).
EnableWWWSubdomain (boolean) --
When true, the subdomain www.DomainName is associated with the App Runner service in addition to the base domain.
CertificateValidationRecords (list) --
A list of certificate CNAME records that's used for this domain name.
(dict) --
Describes a certificate CNAME record to add to your DNS. For more information, see AssociateCustomDomain.
Name (string) --
The certificate CNAME record name.
Type (string) --
The record type, always CNAME.
Value (string) --
The certificate CNAME record value.
Status (string) --
The current state of the certificate CNAME record validation. It should change to SUCCESS after App Runner completes validation with your DNS.
Status (string) --
The current state of the domain name association.
VpcDNSTargets (list) --
DNS Target records for the custom domains of this Amazon VPC.
(dict) --
DNS Target record for a custom domain of this Amazon VPC.
VpcIngressConnectionArn (string) --
The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated with your service.
VpcId (string) --
The ID of the Amazon VPC that is associated with the custom domain name of the target DNS.
DomainName (string) --
The domain name of your target DNS that is associated with the Amazon VPC.
{'Service': {'NetworkConfiguration': {'IngressConfiguration': {'IsPubliclyAccessible': 'boolean'}}}}
Pause an active App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is removed).
This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.
See also: AWS API Documentation
Request Syntax
client.pause_service(
ServiceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the App Runner service that you want to pause.
dict
Response Syntax
{
'Service': {
'ServiceName': 'string',
'ServiceId': 'string',
'ServiceArn': 'string',
'ServiceUrl': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'DeletedAt': datetime(2015, 1, 1),
'Status': 'CREATE_FAILED'|'RUNNING'|'DELETED'|'DELETE_FAILED'|'PAUSED'|'OPERATION_IN_PROGRESS',
'SourceConfiguration': {
'CodeRepository': {
'RepositoryUrl': 'string',
'SourceCodeVersion': {
'Type': 'BRANCH',
'Value': 'string'
},
'CodeConfiguration': {
'ConfigurationSource': 'REPOSITORY'|'API',
'CodeConfigurationValues': {
'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
'BuildCommand': 'string',
'StartCommand': 'string',
'Port': 'string',
'RuntimeEnvironmentVariables': {
'string': 'string'
}
}
}
},
'ImageRepository': {
'ImageIdentifier': 'string',
'ImageConfiguration': {
'RuntimeEnvironmentVariables': {
'string': 'string'
},
'StartCommand': 'string',
'Port': 'string'
},
'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
},
'AutoDeploymentsEnabled': True|False,
'AuthenticationConfiguration': {
'ConnectionArn': 'string',
'AccessRoleArn': 'string'
}
},
'InstanceConfiguration': {
'Cpu': 'string',
'Memory': 'string',
'InstanceRoleArn': 'string'
},
'EncryptionConfiguration': {
'KmsKey': 'string'
},
'HealthCheckConfiguration': {
'Protocol': 'TCP'|'HTTP',
'Path': 'string',
'Interval': 123,
'Timeout': 123,
'HealthyThreshold': 123,
'UnhealthyThreshold': 123
},
'AutoScalingConfigurationSummary': {
'AutoScalingConfigurationArn': 'string',
'AutoScalingConfigurationName': 'string',
'AutoScalingConfigurationRevision': 123
},
'NetworkConfiguration': {
'EgressConfiguration': {
'EgressType': 'DEFAULT'|'VPC',
'VpcConnectorArn': 'string'
},
'IngressConfiguration': {
'IsPubliclyAccessible': True|False
}
},
'ObservabilityConfiguration': {
'ObservabilityEnabled': True|False,
'ObservabilityConfigurationArn': 'string'
}
},
'OperationId': 'string'
}
Response Structure
(dict) --
Service (dict) --
A description of the App Runner service that this request just paused.
ServiceName (string) --
The customer-provided service name.
ServiceId (string) --
An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
ServiceArn (string) --
The Amazon Resource Name (ARN) of this service.
ServiceUrl (string) --
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
CreatedAt (datetime) --
The time when the App Runner service was created. It's in the Unix time stamp format.
UpdatedAt (datetime) --
The time when the App Runner service was last updated at. It's in the Unix time stamp format.
DeletedAt (datetime) --
The time when the App Runner service was deleted. It's in the Unix time stamp format.
Status (string) --
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 (dict) --
The source deployed to the App Runner service. It can be a code or an image repository.
CodeRepository (dict) --
The description of a source code repository.
You must provide either this member or ImageRepository (but not both).
RepositoryUrl (string) --
The location of the repository that contains the source code.
SourceCodeVersion (dict) --
The version that should be used within the source code repository.
Type (string) --
The type of version identifier.
For a git-based repository, branches represent versions.
Value (string) --
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.
CodeConfiguration (dict) --
Configuration for building and running the service from a source code repository.
ConfigurationSource (string) --
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 (dict) --
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).
Runtime (string) --
A runtime environment type for building and running an App Runner service. It represents a programming language runtime.
BuildCommand (string) --
The command App Runner runs to build your application.
StartCommand (string) --
The command App Runner runs to start your application.
Port (string) --
The port that your application listens to in the container.
Default: 8080
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
ImageRepository (dict) --
The description of a source image repository.
You must provide either this member or CodeRepository (but not both).
ImageIdentifier (string) --
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 (dict) --
Configuration for running the identified image.
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
StartCommand (string) --
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.
Port (string) --
The port that your application listens to in the container.
Default: 8080
ImageRepositoryType (string) --
The type of the image repository. This reflects the repository provider and whether the repository is private or public.
AutoDeploymentsEnabled (boolean) --
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).
AuthenticationConfiguration (dict) --
Describes the resources that are needed to authenticate access to some source repositories.
ConnectionArn (string) --
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.
AccessRoleArn (string) --
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).
InstanceConfiguration (dict) --
The runtime configuration of instances (scaling units) of this service.
Cpu (string) --
The number of CPU units reserved for each instance of your App Runner service.
Default: 1 vCPU
Memory (string) --
The amount of memory, in MB or GB, reserved for each instance of your App Runner service.
Default: 2 GB
InstanceRoleArn (string) --
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.
EncryptionConfiguration (dict) --
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 key.
KmsKey (string) --
The ARN of the KMS key that's used for encryption.
HealthCheckConfiguration (dict) --
The settings for the health check that App Runner performs to monitor the health of this service.
Protocol (string) --
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
Path (string) --
The URL that health check requests are sent to.
Path is only applicable when you set Protocol to HTTP.
Default: "/"
Interval (integer) --
The time interval, in seconds, between health checks.
Default: 5
Timeout (integer) --
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
HealthyThreshold (integer) --
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
UnhealthyThreshold (integer) --
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 5
AutoScalingConfigurationSummary (dict) --
Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
AutoScalingConfigurationArn (string) --
The Amazon Resource Name (ARN) of this auto scaling configuration.
AutoScalingConfigurationName (string) --
The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
AutoScalingConfigurationRevision (integer) --
The revision of this auto scaling configuration. It's unique among all the active configurations ( "Status": "ACTIVE") with the same AutoScalingConfigurationName.
NetworkConfiguration (dict) --
Configuration settings related to network traffic of the web application that this service runs.
EgressConfiguration (dict) --
Network configuration settings for outbound message traffic.
EgressType (string) --
The type of egress configuration.
Set to DEFAULT for access to resources hosted on public networks.
Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.
VpcConnectorArn (string) --
The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.
IngressConfiguration (dict) --
Network configuration settings for inbound message traffic.
IsPubliclyAccessible (boolean) --
Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.
ObservabilityConfiguration (dict) --
The observability configuration of this service.
ObservabilityEnabled (boolean) --
When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.
ObservabilityConfigurationArn (string) --
The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.
Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3
Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing
OperationId (string) --
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.
{'Service': {'NetworkConfiguration': {'IngressConfiguration': {'IsPubliclyAccessible': 'boolean'}}}}
Resume an active App Runner service. App Runner provisions compute capacity for the service.
This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.
See also: AWS API Documentation
Request Syntax
client.resume_service(
ServiceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the App Runner service that you want to resume.
dict
Response Syntax
{
'Service': {
'ServiceName': 'string',
'ServiceId': 'string',
'ServiceArn': 'string',
'ServiceUrl': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'DeletedAt': datetime(2015, 1, 1),
'Status': 'CREATE_FAILED'|'RUNNING'|'DELETED'|'DELETE_FAILED'|'PAUSED'|'OPERATION_IN_PROGRESS',
'SourceConfiguration': {
'CodeRepository': {
'RepositoryUrl': 'string',
'SourceCodeVersion': {
'Type': 'BRANCH',
'Value': 'string'
},
'CodeConfiguration': {
'ConfigurationSource': 'REPOSITORY'|'API',
'CodeConfigurationValues': {
'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
'BuildCommand': 'string',
'StartCommand': 'string',
'Port': 'string',
'RuntimeEnvironmentVariables': {
'string': 'string'
}
}
}
},
'ImageRepository': {
'ImageIdentifier': 'string',
'ImageConfiguration': {
'RuntimeEnvironmentVariables': {
'string': 'string'
},
'StartCommand': 'string',
'Port': 'string'
},
'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
},
'AutoDeploymentsEnabled': True|False,
'AuthenticationConfiguration': {
'ConnectionArn': 'string',
'AccessRoleArn': 'string'
}
},
'InstanceConfiguration': {
'Cpu': 'string',
'Memory': 'string',
'InstanceRoleArn': 'string'
},
'EncryptionConfiguration': {
'KmsKey': 'string'
},
'HealthCheckConfiguration': {
'Protocol': 'TCP'|'HTTP',
'Path': 'string',
'Interval': 123,
'Timeout': 123,
'HealthyThreshold': 123,
'UnhealthyThreshold': 123
},
'AutoScalingConfigurationSummary': {
'AutoScalingConfigurationArn': 'string',
'AutoScalingConfigurationName': 'string',
'AutoScalingConfigurationRevision': 123
},
'NetworkConfiguration': {
'EgressConfiguration': {
'EgressType': 'DEFAULT'|'VPC',
'VpcConnectorArn': 'string'
},
'IngressConfiguration': {
'IsPubliclyAccessible': True|False
}
},
'ObservabilityConfiguration': {
'ObservabilityEnabled': True|False,
'ObservabilityConfigurationArn': 'string'
}
},
'OperationId': 'string'
}
Response Structure
(dict) --
Service (dict) --
A description of the App Runner service that this request just resumed.
ServiceName (string) --
The customer-provided service name.
ServiceId (string) --
An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
ServiceArn (string) --
The Amazon Resource Name (ARN) of this service.
ServiceUrl (string) --
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
CreatedAt (datetime) --
The time when the App Runner service was created. It's in the Unix time stamp format.
UpdatedAt (datetime) --
The time when the App Runner service was last updated at. It's in the Unix time stamp format.
DeletedAt (datetime) --
The time when the App Runner service was deleted. It's in the Unix time stamp format.
Status (string) --
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 (dict) --
The source deployed to the App Runner service. It can be a code or an image repository.
CodeRepository (dict) --
The description of a source code repository.
You must provide either this member or ImageRepository (but not both).
RepositoryUrl (string) --
The location of the repository that contains the source code.
SourceCodeVersion (dict) --
The version that should be used within the source code repository.
Type (string) --
The type of version identifier.
For a git-based repository, branches represent versions.
Value (string) --
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.
CodeConfiguration (dict) --
Configuration for building and running the service from a source code repository.
ConfigurationSource (string) --
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 (dict) --
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).
Runtime (string) --
A runtime environment type for building and running an App Runner service. It represents a programming language runtime.
BuildCommand (string) --
The command App Runner runs to build your application.
StartCommand (string) --
The command App Runner runs to start your application.
Port (string) --
The port that your application listens to in the container.
Default: 8080
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
ImageRepository (dict) --
The description of a source image repository.
You must provide either this member or CodeRepository (but not both).
ImageIdentifier (string) --
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 (dict) --
Configuration for running the identified image.
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
StartCommand (string) --
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.
Port (string) --
The port that your application listens to in the container.
Default: 8080
ImageRepositoryType (string) --
The type of the image repository. This reflects the repository provider and whether the repository is private or public.
AutoDeploymentsEnabled (boolean) --
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).
AuthenticationConfiguration (dict) --
Describes the resources that are needed to authenticate access to some source repositories.
ConnectionArn (string) --
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.
AccessRoleArn (string) --
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).
InstanceConfiguration (dict) --
The runtime configuration of instances (scaling units) of this service.
Cpu (string) --
The number of CPU units reserved for each instance of your App Runner service.
Default: 1 vCPU
Memory (string) --
The amount of memory, in MB or GB, reserved for each instance of your App Runner service.
Default: 2 GB
InstanceRoleArn (string) --
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.
EncryptionConfiguration (dict) --
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 key.
KmsKey (string) --
The ARN of the KMS key that's used for encryption.
HealthCheckConfiguration (dict) --
The settings for the health check that App Runner performs to monitor the health of this service.
Protocol (string) --
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
Path (string) --
The URL that health check requests are sent to.
Path is only applicable when you set Protocol to HTTP.
Default: "/"
Interval (integer) --
The time interval, in seconds, between health checks.
Default: 5
Timeout (integer) --
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
HealthyThreshold (integer) --
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
UnhealthyThreshold (integer) --
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 5
AutoScalingConfigurationSummary (dict) --
Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
AutoScalingConfigurationArn (string) --
The Amazon Resource Name (ARN) of this auto scaling configuration.
AutoScalingConfigurationName (string) --
The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
AutoScalingConfigurationRevision (integer) --
The revision of this auto scaling configuration. It's unique among all the active configurations ( "Status": "ACTIVE") with the same AutoScalingConfigurationName.
NetworkConfiguration (dict) --
Configuration settings related to network traffic of the web application that this service runs.
EgressConfiguration (dict) --
Network configuration settings for outbound message traffic.
EgressType (string) --
The type of egress configuration.
Set to DEFAULT for access to resources hosted on public networks.
Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.
VpcConnectorArn (string) --
The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.
IngressConfiguration (dict) --
Network configuration settings for inbound message traffic.
IsPubliclyAccessible (boolean) --
Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.
ObservabilityConfiguration (dict) --
The observability configuration of this service.
ObservabilityEnabled (boolean) --
When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.
ObservabilityConfigurationArn (string) --
The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.
Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3
Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing
OperationId (string) --
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.
{'NetworkConfiguration': {'IngressConfiguration': {'IsPubliclyAccessible': 'boolean'}}}
Response {'Service': {'NetworkConfiguration': {'IngressConfiguration': {'IsPubliclyAccessible': 'boolean'}}}}
Update an App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service. These can be set only when you create the service.
To update the tags applied to your service, use the separate actions TagResource and UntagResource.
This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.
See also: AWS API Documentation
Request Syntax
client.update_service(
ServiceArn='string',
SourceConfiguration={
'CodeRepository': {
'RepositoryUrl': 'string',
'SourceCodeVersion': {
'Type': 'BRANCH',
'Value': 'string'
},
'CodeConfiguration': {
'ConfigurationSource': 'REPOSITORY'|'API',
'CodeConfigurationValues': {
'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
'BuildCommand': 'string',
'StartCommand': 'string',
'Port': 'string',
'RuntimeEnvironmentVariables': {
'string': 'string'
}
}
}
},
'ImageRepository': {
'ImageIdentifier': 'string',
'ImageConfiguration': {
'RuntimeEnvironmentVariables': {
'string': 'string'
},
'StartCommand': 'string',
'Port': 'string'
},
'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
},
'AutoDeploymentsEnabled': True|False,
'AuthenticationConfiguration': {
'ConnectionArn': 'string',
'AccessRoleArn': 'string'
}
},
InstanceConfiguration={
'Cpu': 'string',
'Memory': 'string',
'InstanceRoleArn': 'string'
},
AutoScalingConfigurationArn='string',
HealthCheckConfiguration={
'Protocol': 'TCP'|'HTTP',
'Path': 'string',
'Interval': 123,
'Timeout': 123,
'HealthyThreshold': 123,
'UnhealthyThreshold': 123
},
NetworkConfiguration={
'EgressConfiguration': {
'EgressType': 'DEFAULT'|'VPC',
'VpcConnectorArn': 'string'
},
'IngressConfiguration': {
'IsPubliclyAccessible': True|False
}
},
ObservabilityConfiguration={
'ObservabilityEnabled': True|False,
'ObservabilityConfigurationArn': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the App Runner service that you want to update.
dict
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.
CodeRepository (dict) --
The description of a source code repository.
You must provide either this member or ImageRepository (but not both).
RepositoryUrl (string) -- [REQUIRED]
The location of the repository that contains the source code.
SourceCodeVersion (dict) -- [REQUIRED]
The version that should be used within the source code repository.
Type (string) -- [REQUIRED]
The type of version identifier.
For a git-based repository, branches represent versions.
Value (string) -- [REQUIRED]
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.
CodeConfiguration (dict) --
Configuration for building and running the service from a source code repository.
ConfigurationSource (string) -- [REQUIRED]
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 (dict) --
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).
Runtime (string) -- [REQUIRED]
A runtime environment type for building and running an App Runner service. It represents a programming language runtime.
BuildCommand (string) --
The command App Runner runs to build your application.
StartCommand (string) --
The command App Runner runs to start your application.
Port (string) --
The port that your application listens to in the container.
Default: 8080
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
ImageRepository (dict) --
The description of a source image repository.
You must provide either this member or CodeRepository (but not both).
ImageIdentifier (string) -- [REQUIRED]
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 (dict) --
Configuration for running the identified image.
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
StartCommand (string) --
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.
Port (string) --
The port that your application listens to in the container.
Default: 8080
ImageRepositoryType (string) -- [REQUIRED]
The type of the image repository. This reflects the repository provider and whether the repository is private or public.
AutoDeploymentsEnabled (boolean) --
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).
AuthenticationConfiguration (dict) --
Describes the resources that are needed to authenticate access to some source repositories.
ConnectionArn (string) --
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.
AccessRoleArn (string) --
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).
dict
The runtime configuration to apply to instances (scaling units) of your service.
Cpu (string) --
The number of CPU units reserved for each instance of your App Runner service.
Default: 1 vCPU
Memory (string) --
The amount of memory, in MB or GB, reserved for each instance of your App Runner service.
Default: 2 GB
InstanceRoleArn (string) --
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.
string
The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service.
dict
The settings for the health check that App Runner performs to monitor the health of the App Runner service.
Protocol (string) --
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
Path (string) --
The URL that health check requests are sent to.
Path is only applicable when you set Protocol to HTTP.
Default: "/"
Interval (integer) --
The time interval, in seconds, between health checks.
Default: 5
Timeout (integer) --
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
HealthyThreshold (integer) --
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
UnhealthyThreshold (integer) --
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 5
dict
Configuration settings related to network traffic of the web application that the App Runner service runs.
EgressConfiguration (dict) --
Network configuration settings for outbound message traffic.
EgressType (string) --
The type of egress configuration.
Set to DEFAULT for access to resources hosted on public networks.
Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.
VpcConnectorArn (string) --
The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.
IngressConfiguration (dict) --
Network configuration settings for inbound message traffic.
IsPubliclyAccessible (boolean) --
Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.
dict
The observability configuration of your service.
ObservabilityEnabled (boolean) -- [REQUIRED]
When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.
ObservabilityConfigurationArn (string) --
The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.
Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3
Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing
dict
Response Syntax
{
'Service': {
'ServiceName': 'string',
'ServiceId': 'string',
'ServiceArn': 'string',
'ServiceUrl': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'DeletedAt': datetime(2015, 1, 1),
'Status': 'CREATE_FAILED'|'RUNNING'|'DELETED'|'DELETE_FAILED'|'PAUSED'|'OPERATION_IN_PROGRESS',
'SourceConfiguration': {
'CodeRepository': {
'RepositoryUrl': 'string',
'SourceCodeVersion': {
'Type': 'BRANCH',
'Value': 'string'
},
'CodeConfiguration': {
'ConfigurationSource': 'REPOSITORY'|'API',
'CodeConfigurationValues': {
'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
'BuildCommand': 'string',
'StartCommand': 'string',
'Port': 'string',
'RuntimeEnvironmentVariables': {
'string': 'string'
}
}
}
},
'ImageRepository': {
'ImageIdentifier': 'string',
'ImageConfiguration': {
'RuntimeEnvironmentVariables': {
'string': 'string'
},
'StartCommand': 'string',
'Port': 'string'
},
'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
},
'AutoDeploymentsEnabled': True|False,
'AuthenticationConfiguration': {
'ConnectionArn': 'string',
'AccessRoleArn': 'string'
}
},
'InstanceConfiguration': {
'Cpu': 'string',
'Memory': 'string',
'InstanceRoleArn': 'string'
},
'EncryptionConfiguration': {
'KmsKey': 'string'
},
'HealthCheckConfiguration': {
'Protocol': 'TCP'|'HTTP',
'Path': 'string',
'Interval': 123,
'Timeout': 123,
'HealthyThreshold': 123,
'UnhealthyThreshold': 123
},
'AutoScalingConfigurationSummary': {
'AutoScalingConfigurationArn': 'string',
'AutoScalingConfigurationName': 'string',
'AutoScalingConfigurationRevision': 123
},
'NetworkConfiguration': {
'EgressConfiguration': {
'EgressType': 'DEFAULT'|'VPC',
'VpcConnectorArn': 'string'
},
'IngressConfiguration': {
'IsPubliclyAccessible': True|False
}
},
'ObservabilityConfiguration': {
'ObservabilityEnabled': True|False,
'ObservabilityConfigurationArn': 'string'
}
},
'OperationId': 'string'
}
Response Structure
(dict) --
Service (dict) --
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.
ServiceName (string) --
The customer-provided service name.
ServiceId (string) --
An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
ServiceArn (string) --
The Amazon Resource Name (ARN) of this service.
ServiceUrl (string) --
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
CreatedAt (datetime) --
The time when the App Runner service was created. It's in the Unix time stamp format.
UpdatedAt (datetime) --
The time when the App Runner service was last updated at. It's in the Unix time stamp format.
DeletedAt (datetime) --
The time when the App Runner service was deleted. It's in the Unix time stamp format.
Status (string) --
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 (dict) --
The source deployed to the App Runner service. It can be a code or an image repository.
CodeRepository (dict) --
The description of a source code repository.
You must provide either this member or ImageRepository (but not both).
RepositoryUrl (string) --
The location of the repository that contains the source code.
SourceCodeVersion (dict) --
The version that should be used within the source code repository.
Type (string) --
The type of version identifier.
For a git-based repository, branches represent versions.
Value (string) --
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.
CodeConfiguration (dict) --
Configuration for building and running the service from a source code repository.
ConfigurationSource (string) --
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 (dict) --
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).
Runtime (string) --
A runtime environment type for building and running an App Runner service. It represents a programming language runtime.
BuildCommand (string) --
The command App Runner runs to build your application.
StartCommand (string) --
The command App Runner runs to start your application.
Port (string) --
The port that your application listens to in the container.
Default: 8080
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
ImageRepository (dict) --
The description of a source image repository.
You must provide either this member or CodeRepository (but not both).
ImageIdentifier (string) --
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 (dict) --
Configuration for running the identified image.
RuntimeEnvironmentVariables (dict) --
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) --
(string) --
StartCommand (string) --
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.
Port (string) --
The port that your application listens to in the container.
Default: 8080
ImageRepositoryType (string) --
The type of the image repository. This reflects the repository provider and whether the repository is private or public.
AutoDeploymentsEnabled (boolean) --
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).
AuthenticationConfiguration (dict) --
Describes the resources that are needed to authenticate access to some source repositories.
ConnectionArn (string) --
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.
AccessRoleArn (string) --
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).
InstanceConfiguration (dict) --
The runtime configuration of instances (scaling units) of this service.
Cpu (string) --
The number of CPU units reserved for each instance of your App Runner service.
Default: 1 vCPU
Memory (string) --
The amount of memory, in MB or GB, reserved for each instance of your App Runner service.
Default: 2 GB
InstanceRoleArn (string) --
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.
EncryptionConfiguration (dict) --
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 key.
KmsKey (string) --
The ARN of the KMS key that's used for encryption.
HealthCheckConfiguration (dict) --
The settings for the health check that App Runner performs to monitor the health of this service.
Protocol (string) --
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
Path (string) --
The URL that health check requests are sent to.
Path is only applicable when you set Protocol to HTTP.
Default: "/"
Interval (integer) --
The time interval, in seconds, between health checks.
Default: 5
Timeout (integer) --
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
HealthyThreshold (integer) --
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
UnhealthyThreshold (integer) --
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 5
AutoScalingConfigurationSummary (dict) --
Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
AutoScalingConfigurationArn (string) --
The Amazon Resource Name (ARN) of this auto scaling configuration.
AutoScalingConfigurationName (string) --
The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
AutoScalingConfigurationRevision (integer) --
The revision of this auto scaling configuration. It's unique among all the active configurations ( "Status": "ACTIVE") with the same AutoScalingConfigurationName.
NetworkConfiguration (dict) --
Configuration settings related to network traffic of the web application that this service runs.
EgressConfiguration (dict) --
Network configuration settings for outbound message traffic.
EgressType (string) --
The type of egress configuration.
Set to DEFAULT for access to resources hosted on public networks.
Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.
VpcConnectorArn (string) --
The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.
IngressConfiguration (dict) --
Network configuration settings for inbound message traffic.
IsPubliclyAccessible (boolean) --
Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.
ObservabilityConfiguration (dict) --
The observability configuration of this service.
ObservabilityEnabled (boolean) --
When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.
ObservabilityConfigurationArn (string) --
The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.
Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3
Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing
OperationId (string) --
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.