Amazon.AppRunner.Model

Paginators for the AppRunner service

Container for the parameters to the AssociateCustomDomain operation. 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).

This is the response object from the AssociateCustomDomain operation.

Describes resources needed to authenticate access to some source repositories. The specific resource depends on the repository provider.

Describes an App Runner automatic scaling configuration resource.

A higher MinSize increases the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost.

A lower MaxSize controls your cost. The tradeoff is lower responsiveness during peak demand.

Multiple revisions of a configuration might have the same AutoScalingConfigurationName and different AutoScalingConfigurationRevision values.

Provides summary information about an App Runner automatic scaling configuration resource.

This type contains limited information about an auto scaling configuration. It includes only identification information, without configuration details. It's returned by the ListAutoScalingConfigurations action. Complete configuration information is returned by the CreateAutoScalingConfiguration, DescribeAutoScalingConfiguration, and DeleteAutoScalingConfiguration actions using the AutoScalingConfiguration type.

Describes a certificate CNAME record to add to your DNS. For more information, see AssociateCustomDomain.

Describes the configuration that App Runner uses to build and run an App Runner service from a source code repository.

Describes the basic configuration needed for building and running an App Runner service. This type doesn't support the full set of possible configuration options. Fur full configuration capabilities, use a apprunner.yaml file in the source code repository.

Describes a source code repository.

Describes an App Runner connection resource.

Provides summary information about an App Runner connection resource.

Container for the parameters to the CreateAutoScalingConfiguration operation. Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create or update App Runner services and you require non-default auto scaling settings. You can share an auto scaling configuration across multiple services.

Create multiple revisions of a configuration by calling this action multiple times using the same AutoScalingConfigurationName. The call returns incremental AutoScalingConfigurationRevision values. When you create a service and configure an auto scaling configuration resource, the service uses the latest active revision of the auto scaling configuration by default. You can optionally configure the service to use a specific revision.

Configure a higher MinSize to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost.

Configure a lower MaxSize to control your cost. The tradeoff is lower responsiveness during peak demand.

This is the response object from the CreateAutoScalingConfiguration operation.

Container for the parameters to the CreateConnection operation. Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from certain third-party providers. You can share a connection across multiple services.

A connection resource is needed to access GitHub and Bitbucket repositories. Both require a user interface approval process through the App Runner console before you can use the connection.

This is the response object from the CreateConnection operation.

Container for the parameters to the CreateObservabilityConfiguration operation. Create an App Runner observability configuration resource. App Runner requires this resource when you create or update App Runner services and you want to enable non-default observability features. You can share an observability configuration across multiple services.

Create multiple revisions of a configuration by calling this action multiple times using the same ObservabilityConfigurationName. The call returns incremental ObservabilityConfigurationRevision values. When you create a service and configure an observability configuration resource, the service uses the latest active revision of the observability configuration by default. You can optionally configure the service to use a specific revision.

The observability configuration resource is designed to configure multiple features (currently one feature, tracing). This action takes optional parameters that describe the configuration of these features (currently one parameter, TraceConfiguration). If you don't specify a feature parameter, App Runner doesn't enable the feature.

This is the response object from the CreateObservabilityConfiguration operation.

Container for the parameters to the CreateService operation. 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.

This is the response object from the CreateService operation.

Container for the parameters to the CreateVpcConnector operation. Create an App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud (Amazon VPC).

This is the response object from the CreateVpcConnector operation.

Container for the parameters to the CreateVpcIngressConnection operation. 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.

This is the response object from the CreateVpcIngressConnection operation.

Describes a custom domain that's associated with an App Runner service.

Container for the parameters to the DeleteAutoScalingConfiguration operation. Delete an App Runner automatic scaling configuration resource. You can delete a top level auto scaling configuration, a specific revision of one, or all revisions associated with the top level configuration. You can't delete the default auto scaling configuration or a configuration that's used by one or more App Runner services.

This is the response object from the DeleteAutoScalingConfiguration operation.

Container for the parameters to the DeleteConnection operation. Delete an App Runner connection. You must first ensure that there are no running App Runner services that use this connection. If there are any, the DeleteConnection action fails.

This is the response object from the DeleteConnection operation.

Container for the parameters to the DeleteObservabilityConfiguration operation. Delete an App Runner observability configuration resource. You can delete a specific revision or the latest active revision. You can't delete a configuration that's used by one or more App Runner services.

This is the response object from the DeleteObservabilityConfiguration operation.

Container for the parameters to the DeleteService operation. 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.

This is the response object from the DeleteService operation.

Container for the parameters to the DeleteVpcConnector operation. Delete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services.

This is the response object from the DeleteVpcConnector operation.

Container for the parameters to the DeleteVpcIngressConnection operation. 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

This is the response object from the DeleteVpcIngressConnection operation.

Container for the parameters to the DescribeAutoScalingConfiguration operation. Return a full description of an App Runner automatic scaling configuration resource.

This is the response object from the DescribeAutoScalingConfiguration operation.

Container for the parameters to the DescribeCustomDomains operation. Return a description of custom domain names that are associated with an App Runner service.

This is the response object from the DescribeCustomDomains operation.

Container for the parameters to the DescribeObservabilityConfiguration operation. Return a full description of an App Runner observability configuration resource.

This is the response object from the DescribeObservabilityConfiguration operation.

Container for the parameters to the DescribeService operation. Return a full description of an App Runner service.

This is the response object from the DescribeService operation.

Container for the parameters to the DescribeVpcConnector operation. Return a description of an App Runner VPC connector resource.

This is the response object from the DescribeVpcConnector operation.

Container for the parameters to the DescribeVpcIngressConnection operation. Return a full description of an App Runner VPC Ingress Connection resource.

This is the response object from the DescribeVpcIngressConnection operation.

Container for the parameters to the DisassociateCustomDomain operation. 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.

This is the response object from the DisassociateCustomDomain operation.

Describes configuration settings related to outbound network traffic of an App Runner service.

Describes a custom encryption key that App Runner uses to encrypt copies of the source repository and service logs.

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

Describes the configuration that App Runner uses to run an App Runner service using an image pulled from a source image repository.

Describes a source image repository.

Network configuration settings for inbound network traffic.

The configuration of your VPC and the associated VPC endpoint. The VPC endpoint is an Amazon Web Services PrivateLink resource that allows access to your App Runner services from within an Amazon VPC.

Describes the runtime configuration of an App Runner service instance (scaling unit).

An unexpected service exception occurred.

One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.

You can't perform this action when the resource is in its current state.

Container for the parameters to the ListAutoScalingConfigurations operation. Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name.

To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by ListAutoScalingConfigurations.

This is the response object from the ListAutoScalingConfigurations operation.

Container for the parameters to the ListConnections operation. Returns a list of App Runner connections that are associated with your Amazon Web Services account.

This is the response object from the ListConnections operation.

Container for the parameters to the ListObservabilityConfigurations operation. Returns a list of active App Runner observability configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name.

To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by ListObservabilityConfigurations.

This is the response object from the ListObservabilityConfigurations operation.

Container for the parameters to the ListOperations operation. Return a list of operations that occurred on an App Runner service.

The resulting list of OperationSummary objects is sorted in reverse chronological order. The first object on the list represents the last started operation.

This is the response object from the ListOperations operation.

Container for the parameters to the ListServicesForAutoScalingConfiguration operation. Returns a list of the associated App Runner services using an auto scaling configuration.

This is the response object from the ListServicesForAutoScalingConfiguration operation.

Container for the parameters to the ListServices operation. Returns a list of running App Runner services in your Amazon Web Services account.

This is the response object from the ListServices operation.

Container for the parameters to the ListTagsForResource operation. List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs.

This is the response object from the ListTagsForResource operation.

Container for the parameters to the ListVpcConnectors operation. Returns a list of App Runner VPC connectors in your Amazon Web Services account.

This is the response object from the ListVpcConnectors operation.

Returns a list of VPC Ingress Connections based on the filter provided. It can return either ServiceArn or VpcEndpointId, or both.

Container for the parameters to the ListVpcIngressConnections operation. Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.

This is the response object from the ListVpcIngressConnections operation.

Describes configuration settings related to network traffic of an App Runner service. Consists of embedded objects for each configurable network feature.

Describes an App Runner observability configuration resource. Multiple revisions of a configuration have the same ObservabilityConfigurationName and different ObservabilityConfigurationRevision values.

The resource is designed to configure multiple features (currently one feature, tracing). This type contains optional members that describe the configuration of these features (currently one member, TraceConfiguration). If a feature member isn't specified, the feature isn't enabled.

Provides summary information about an App Runner observability configuration resource.

This type contains limited information about an observability configuration. It includes only identification information, without configuration details. It's returned by the ListObservabilityConfigurations action. Complete configuration information is returned by the CreateObservabilityConfiguration, DescribeObservabilityConfiguration, and DeleteObservabilityConfiguration actions using the ObservabilityConfiguration type.

Provides summary information for an operation that occurred on an App Runner service.

Container for the parameters to the PauseService operation. 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.

This is the response object from the PauseService operation.

A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.

Container for the parameters to the ResumeService operation. 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.

This is the response object from the ResumeService operation.

Describes an App Runner service. It can describe a service in any state, including deleted services.

This type contains the full information about a service, including configuration details. It's returned by the CreateService, DescribeService, and DeleteService actions. A subset of this information is returned by the ListServices action using the ServiceSummary type.

Describes the observability configuration of an App Runner service. These are additional observability features, like tracing, that you choose to enable. They're configured in a separate resource that you associate with your service.

App Runner can't create this resource. You've reached your account quota for this resource type.

For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.

Provides summary information for an App Runner service.

This type contains limited information about a service. It doesn't include configuration details. It's returned by the ListServices action. Complete service information is returned by the CreateService, DescribeService, and DeleteService actions using the Service type.

Identifies a version of code that App Runner refers to within a source code repository.

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

Container for the parameters to the StartDeployment operation. Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner service.

For a source code repository, App Runner retrieves the commit and builds a Docker image. For a source image repository, App Runner retrieves the latest Docker image. In both cases, App Runner then deploys the new image to your service and starts a new container instance.

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.

This is the response object from the StartDeployment operation.

Describes a tag that is applied to an App Runner resource. A tag is a metadata item consisting of a key-value pair.

Container for the parameters to the TagResource operation. Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.

This is the response object from the TagResource operation.

Describes the configuration of the tracing feature within an App Runner observability configuration.

Container for the parameters to the UntagResource operation. Remove tags from an App Runner resource.

This is the response object from the UntagResource operation.

Container for the parameters to the UpdateDefaultAutoScalingConfiguration operation. Update an auto scaling configuration to be the default. The existing default auto scaling configuration will be set to non-default automatically.

This is the response object from the UpdateDefaultAutoScalingConfiguration operation.

Container for the parameters to the UpdateService operation. 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.

This is the response object from the UpdateService operation.

Container for the parameters to the UpdateVpcIngressConnection operation. 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

This is the response object from the UpdateVpcIngressConnection operation.

Describes an App Runner VPC connector resource. A VPC connector describes the Amazon Virtual Private Cloud (Amazon VPC) that an App Runner service is associated with, and the subnets and security group that are used.

Multiple revisions of a connector might have the same Name and different Revision values.

DNS Target record for a custom domain of this Amazon VPC.

The App Runner resource that specifies an App Runner endpoint for incoming traffic. It establishes a connection between a VPC interface endpoint and a App Runner service, to make your App Runner service accessible from only within an Amazon VPC.

Provides summary information about an VPC Ingress Connection, which includes its VPC Ingress Connection ARN and its associated Service ARN.

Paginators for the AppRunner service

Paginator for the DescribeCustomDomains operation

Paginator for the ListAutoScalingConfigurations operation

Paginator for the ListConnections operation

Paginator for the ListObservabilityConfigurations operation

Paginator for the ListOperations operation

Paginator for the ListServicesForAutoScalingConfiguration operation

Paginator for the ListServices operation

Paginator for the ListVpcConnectors operation

Paginator for the ListVpcIngressConnections operation