@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSAppRunnerAsync extends AWSAppRunner
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSAppRunnerAsync instead.
App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code to a running service in the Amazon Web Services Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to provision and configure Amazon Web Services resources.
App Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations, high performance, scalability, and security.
For more information about App Runner, see the App Runner Developer Guide. For release information, see the App Runner Release Notes.
To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see Tools for Amazon Web Services.
Endpoints
For a list of Region-specific endpoints that App Runner supports, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
ENDPOINT_PREFIXassociateCustomDomain, createAutoScalingConfiguration, createConnection, createService, deleteAutoScalingConfiguration, deleteConnection, deleteService, describeAutoScalingConfiguration, describeCustomDomains, describeService, disassociateCustomDomain, getCachedResponseMetadata, listAutoScalingConfigurations, listConnections, listOperations, listServices, listTagsForResource, pauseService, resumeService, shutdown, startDeployment, tagResource, untagResource, updateServiceFuture<AssociateCustomDomainResult> associateCustomDomainAsync(AssociateCustomDomainRequest associateCustomDomainRequest)
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).
associateCustomDomainRequest - Future<AssociateCustomDomainResult> associateCustomDomainAsync(AssociateCustomDomainRequest associateCustomDomainRequest, AsyncHandler<AssociateCustomDomainRequest,AssociateCustomDomainResult> asyncHandler)
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).
associateCustomDomainRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAutoScalingConfigurationResult> createAutoScalingConfigurationAsync(CreateAutoScalingConfigurationRequest createAutoScalingConfigurationRequest)
Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create App Runner services that require non-default auto scaling settings. You can share an auto scaling configuration across multiple services.
Create multiple revisions of a configuration by using the same AutoScalingConfigurationName and
different AutoScalingConfigurationRevision values. When you create a service, you can set it to use
the latest active revision of an auto scaling configuration or 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.
createAutoScalingConfigurationRequest - Future<CreateAutoScalingConfigurationResult> createAutoScalingConfigurationAsync(CreateAutoScalingConfigurationRequest createAutoScalingConfigurationRequest, AsyncHandler<CreateAutoScalingConfigurationRequest,CreateAutoScalingConfigurationResult> asyncHandler)
Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create App Runner services that require non-default auto scaling settings. You can share an auto scaling configuration across multiple services.
Create multiple revisions of a configuration by using the same AutoScalingConfigurationName and
different AutoScalingConfigurationRevision values. When you create a service, you can set it to use
the latest active revision of an auto scaling configuration or 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.
createAutoScalingConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateConnectionResult> createConnectionAsync(CreateConnectionRequest createConnectionRequest)
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 repositories. GitHub requires a user interface approval process through the App Runner console before you can use the connection.
createConnectionRequest - Future<CreateConnectionResult> createConnectionAsync(CreateConnectionRequest createConnectionRequest, AsyncHandler<CreateConnectionRequest,CreateConnectionResult> asyncHandler)
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 repositories. GitHub requires a user interface approval process through the App Runner console before you can use the connection.
createConnectionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateServiceResult> createServiceAsync(CreateServiceRequest createServiceRequest)
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.
createServiceRequest - Future<CreateServiceResult> createServiceAsync(CreateServiceRequest createServiceRequest, AsyncHandler<CreateServiceRequest,CreateServiceResult> asyncHandler)
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.
createServiceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAutoScalingConfigurationResult> deleteAutoScalingConfigurationAsync(DeleteAutoScalingConfigurationRequest deleteAutoScalingConfigurationRequest)
Delete an App Runner automatic scaling 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.
deleteAutoScalingConfigurationRequest - Future<DeleteAutoScalingConfigurationResult> deleteAutoScalingConfigurationAsync(DeleteAutoScalingConfigurationRequest deleteAutoScalingConfigurationRequest, AsyncHandler<DeleteAutoScalingConfigurationRequest,DeleteAutoScalingConfigurationResult> asyncHandler)
Delete an App Runner automatic scaling 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.
deleteAutoScalingConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteConnectionResult> deleteConnectionAsync(DeleteConnectionRequest deleteConnectionRequest)
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.
deleteConnectionRequest - Future<DeleteConnectionResult> deleteConnectionAsync(DeleteConnectionRequest deleteConnectionRequest, AsyncHandler<DeleteConnectionRequest,DeleteConnectionResult> asyncHandler)
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.
deleteConnectionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteServiceResult> deleteServiceAsync(DeleteServiceRequest deleteServiceRequest)
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.
deleteServiceRequest - Future<DeleteServiceResult> deleteServiceAsync(DeleteServiceRequest deleteServiceRequest, AsyncHandler<DeleteServiceRequest,DeleteServiceResult> asyncHandler)
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.
deleteServiceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAutoScalingConfigurationResult> describeAutoScalingConfigurationAsync(DescribeAutoScalingConfigurationRequest describeAutoScalingConfigurationRequest)
Return a full description of an App Runner automatic scaling configuration resource.
describeAutoScalingConfigurationRequest - Future<DescribeAutoScalingConfigurationResult> describeAutoScalingConfigurationAsync(DescribeAutoScalingConfigurationRequest describeAutoScalingConfigurationRequest, AsyncHandler<DescribeAutoScalingConfigurationRequest,DescribeAutoScalingConfigurationResult> asyncHandler)
Return a full description of an App Runner automatic scaling configuration resource.
describeAutoScalingConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeCustomDomainsResult> describeCustomDomainsAsync(DescribeCustomDomainsRequest describeCustomDomainsRequest)
Return a description of custom domain names that are associated with an App Runner service.
describeCustomDomainsRequest - Future<DescribeCustomDomainsResult> describeCustomDomainsAsync(DescribeCustomDomainsRequest describeCustomDomainsRequest, AsyncHandler<DescribeCustomDomainsRequest,DescribeCustomDomainsResult> asyncHandler)
Return a description of custom domain names that are associated with an App Runner service.
describeCustomDomainsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeServiceResult> describeServiceAsync(DescribeServiceRequest describeServiceRequest)
Return a full description of an App Runner service.
describeServiceRequest - Future<DescribeServiceResult> describeServiceAsync(DescribeServiceRequest describeServiceRequest, AsyncHandler<DescribeServiceRequest,DescribeServiceResult> asyncHandler)
Return a full description of an App Runner service.
describeServiceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateCustomDomainResult> disassociateCustomDomainAsync(DisassociateCustomDomainRequest disassociateCustomDomainRequest)
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.
disassociateCustomDomainRequest - Future<DisassociateCustomDomainResult> disassociateCustomDomainAsync(DisassociateCustomDomainRequest disassociateCustomDomainRequest, AsyncHandler<DisassociateCustomDomainRequest,DisassociateCustomDomainResult> asyncHandler)
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.
disassociateCustomDomainRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAutoScalingConfigurationsResult> listAutoScalingConfigurationsAsync(ListAutoScalingConfigurationsRequest listAutoScalingConfigurationsRequest)
Returns a list of 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 configurations in your account. You can optionally query only the latest revision of each requested name.
listAutoScalingConfigurationsRequest - Future<ListAutoScalingConfigurationsResult> listAutoScalingConfigurationsAsync(ListAutoScalingConfigurationsRequest listAutoScalingConfigurationsRequest, AsyncHandler<ListAutoScalingConfigurationsRequest,ListAutoScalingConfigurationsResult> asyncHandler)
Returns a list of 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 configurations in your account. You can optionally query only the latest revision of each requested name.
listAutoScalingConfigurationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListConnectionsResult> listConnectionsAsync(ListConnectionsRequest listConnectionsRequest)
Returns a list of App Runner connections that are associated with your Amazon Web Services account.
listConnectionsRequest - Future<ListConnectionsResult> listConnectionsAsync(ListConnectionsRequest listConnectionsRequest, AsyncHandler<ListConnectionsRequest,ListConnectionsResult> asyncHandler)
Returns a list of App Runner connections that are associated with your Amazon Web Services account.
listConnectionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListOperationsResult> listOperationsAsync(ListOperationsRequest listOperationsRequest)
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.
listOperationsRequest - Future<ListOperationsResult> listOperationsAsync(ListOperationsRequest listOperationsRequest, AsyncHandler<ListOperationsRequest,ListOperationsResult> asyncHandler)
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.
listOperationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListServicesResult> listServicesAsync(ListServicesRequest listServicesRequest)
Returns a list of running App Runner services in your Amazon Web Services account.
listServicesRequest - Future<ListServicesResult> listServicesAsync(ListServicesRequest listServicesRequest, AsyncHandler<ListServicesRequest,ListServicesResult> asyncHandler)
Returns a list of running App Runner services in your Amazon Web Services account.
listServicesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PauseServiceResult> pauseServiceAsync(PauseServiceRequest pauseServiceRequest)
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.
pauseServiceRequest - Future<PauseServiceResult> pauseServiceAsync(PauseServiceRequest pauseServiceRequest, AsyncHandler<PauseServiceRequest,PauseServiceResult> asyncHandler)
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.
pauseServiceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ResumeServiceResult> resumeServiceAsync(ResumeServiceRequest resumeServiceRequest)
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.
resumeServiceRequest - Future<ResumeServiceResult> resumeServiceAsync(ResumeServiceRequest resumeServiceRequest, AsyncHandler<ResumeServiceRequest,ResumeServiceResult> asyncHandler)
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.
resumeServiceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartDeploymentResult> startDeploymentAsync(StartDeploymentRequest startDeploymentRequest)
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.
startDeploymentRequest - Future<StartDeploymentResult> startDeploymentAsync(StartDeploymentRequest startDeploymentRequest, AsyncHandler<StartDeploymentRequest,StartDeploymentResult> asyncHandler)
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.
startDeploymentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Remove tags from an App Runner resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Remove tags from an App Runner resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateServiceResult> updateServiceAsync(UpdateServiceRequest updateServiceRequest)
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.
updateServiceRequest - Future<UpdateServiceResult> updateServiceAsync(UpdateServiceRequest updateServiceRequest, AsyncHandler<UpdateServiceRequest,UpdateServiceResult> asyncHandler)
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.
updateServiceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.