AbstractAWSAppRunner (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apprunner.AbstractAWSAppRunner

All Implemented Interfaces:

AWSAppRunner

Direct Known Subclasses:

AbstractAWSAppRunnerAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSAppRunner
extends Object
implements AWSAppRunner
```
Abstract implementation of AWSAppRunner. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.apprunner.AWSAppRunner
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateCustomDomainResult`	`associateCustomDomain(AssociateCustomDomainRequest request)` Associate your own domain name with the AWS App Runner subdomain URL of your App Runner service.
`CreateAutoScalingConfigurationResult`	`createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest request)` Create an AWS App Runner automatic scaling configuration resource.
`CreateConnectionResult`	`createConnection(CreateConnectionRequest request)` Create an AWS App Runner connection resource.
`CreateServiceResult`	`createService(CreateServiceRequest request)` Create an AWS App Runner service.
`DeleteAutoScalingConfigurationResult`	`deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest request)` Delete an AWS App Runner automatic scaling configuration resource.
`DeleteConnectionResult`	`deleteConnection(DeleteConnectionRequest request)` Delete an AWS App Runner connection.
`DeleteServiceResult`	`deleteService(DeleteServiceRequest request)` Delete an AWS App Runner service.
`DescribeAutoScalingConfigurationResult`	`describeAutoScalingConfiguration(DescribeAutoScalingConfigurationRequest request)` Return a full description of an AWS App Runner automatic scaling configuration resource.
`DescribeCustomDomainsResult`	`describeCustomDomains(DescribeCustomDomainsRequest request)` Return a description of custom domain names that are associated with an AWS App Runner service.
`DescribeServiceResult`	`describeService(DescribeServiceRequest request)` Return a full description of an AWS App Runner service.
`DisassociateCustomDomainResult`	`disassociateCustomDomain(DisassociateCustomDomainRequest request)` Disassociate a custom domain name from an AWS App Runner service.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListAutoScalingConfigurationsResult`	`listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request)` Returns a list of AWS App Runner automatic scaling configurations in your AWS account.
`ListConnectionsResult`	`listConnections(ListConnectionsRequest request)` Returns a list of AWS App Runner connections that are associated with your AWS account.
`ListOperationsResult`	`listOperations(ListOperationsRequest request)` Return a list of operations that occurred on an AWS App Runner service.
`ListServicesResult`	`listServices(ListServicesRequest request)` Returns a list of running AWS App Runner services in your AWS account.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` List tags that are associated with for an AWS App Runner resource.
`PauseServiceResult`	`pauseService(PauseServiceRequest request)` Pause an active AWS App Runner service.
`ResumeServiceResult`	`resumeService(ResumeServiceRequest request)` Resume an active AWS App Runner service.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartDeploymentResult`	`startDeployment(StartDeploymentRequest request)` Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an AWS App Runner service.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Add tags to, or update the tag values of, an App Runner resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Remove tags from an App Runner resource.
`UpdateServiceResult`	`updateService(UpdateServiceRequest request)` Update an AWS App Runner service.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - associateCustomDomain
```
public AssociateCustomDomainResult associateCustomDomain(AssociateCustomDomainRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Associate your own domain name with the AWS 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).
    
    Specified by:
    
    associateCustomDomain in interface AWSAppRunner
    
    Returns:
    
    Result of the AssociateCustomDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAutoScalingConfiguration
```
public CreateAutoScalingConfigurationResult createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Create an AWS 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 AWS Region. The tradeoff is a higher minimal cost.
    
    Configure a lower MaxSize to control your cost. The tradeoff is lower responsiveness during peak demand.
    
    Specified by:
    
    createAutoScalingConfiguration in interface AWSAppRunner
    
    Returns:
    
    Result of the CreateAutoScalingConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createConnection
```
public CreateConnectionResult createConnection(CreateConnectionRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Create an AWS 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.
    
    Specified by:
    
    createConnection in interface AWSAppRunner
    
    Returns:
    
    Result of the CreateConnection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createService
```
public CreateServiceResult createService(CreateServiceRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Create an AWS 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.
    
    Specified by:
    
    createService in interface AWSAppRunner
    
    Returns:
    
    Result of the CreateService operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAutoScalingConfiguration
```
public DeleteAutoScalingConfigurationResult deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Delete an AWS 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.
    
    Specified by:
    
    deleteAutoScalingConfiguration in interface AWSAppRunner
    
    Returns:
    
    Result of the DeleteAutoScalingConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteConnection
```
public DeleteConnectionResult deleteConnection(DeleteConnectionRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Delete an AWS 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.
    
    Specified by:
    
    deleteConnection in interface AWSAppRunner
    
    Returns:
    
    Result of the DeleteConnection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteService
```
public DeleteServiceResult deleteService(DeleteServiceRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Delete an AWS 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.
    
    Specified by:
    
    deleteService in interface AWSAppRunner
    
    Returns:
    
    Result of the DeleteService operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAutoScalingConfiguration
```
public DescribeAutoScalingConfigurationResult describeAutoScalingConfiguration(DescribeAutoScalingConfigurationRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Return a full description of an AWS App Runner automatic scaling configuration resource.
    
    Specified by:
    
    describeAutoScalingConfiguration in interface AWSAppRunner
    
    Returns:
    
    Result of the DescribeAutoScalingConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCustomDomains
```
public DescribeCustomDomainsResult describeCustomDomains(DescribeCustomDomainsRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Return a description of custom domain names that are associated with an AWS App Runner service.
    
    Specified by:
    
    describeCustomDomains in interface AWSAppRunner
    
    Returns:
    
    Result of the DescribeCustomDomains operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeService
```
public DescribeServiceResult describeService(DescribeServiceRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Return a full description of an AWS App Runner service.
    
    Specified by:
    
    describeService in interface AWSAppRunner
    
    Returns:
    
    Result of the DescribeService operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateCustomDomain
```
public DisassociateCustomDomainResult disassociateCustomDomain(DisassociateCustomDomainRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Disassociate a custom domain name from an AWS 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.
    
    Specified by:
    
    disassociateCustomDomain in interface AWSAppRunner
    
    Returns:
    
    Result of the DisassociateCustomDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAutoScalingConfigurations
```
public ListAutoScalingConfigurationsResult listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Returns a list of AWS App Runner automatic scaling configurations in your AWS 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.
    
    Specified by:
    
    listAutoScalingConfigurations in interface AWSAppRunner
    
    Returns:
    
    Result of the ListAutoScalingConfigurations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listConnections
```
public ListConnectionsResult listConnections(ListConnectionsRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Returns a list of AWS App Runner connections that are associated with your AWS account.
    
    Specified by:
    
    listConnections in interface AWSAppRunner
    
    Returns:
    
    Result of the ListConnections operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listOperations
```
public ListOperationsResult listOperations(ListOperationsRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Return a list of operations that occurred on an AWS 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.
    
    Specified by:
    
    listOperations in interface AWSAppRunner
    
    Returns:
    
    Result of the ListOperations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listServices
```
public ListServicesResult listServices(ListServicesRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Returns a list of running AWS App Runner services in your AWS account.
    
    Specified by:
    
    listServices in interface AWSAppRunner
    
    Returns:
    
    Result of the ListServices operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSAppRunner
    
    List tags that are associated with for an AWS App Runner resource. The response contains a list of tag key-value pairs.
    
    Specified by:
    
    listTagsForResource in interface AWSAppRunner
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - pauseService
```
public PauseServiceResult pauseService(PauseServiceRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Pause an active AWS 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.
    
    Specified by:
    
    pauseService in interface AWSAppRunner
    
    Returns:
    
    Result of the PauseService operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - resumeService
```
public ResumeServiceResult resumeService(ResumeServiceRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Resume an active AWS 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.
    
    Specified by:
    
    resumeService in interface AWSAppRunner
    
    Returns:
    
    Result of the ResumeService operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startDeployment
```
public StartDeploymentResult startDeployment(StartDeploymentRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an AWS 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.
    
    Specified by:
    
    startDeployment in interface AWSAppRunner
    
    Returns:
    
    Result of the StartDeployment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.
    
    Specified by:
    
    tagResource in interface AWSAppRunner
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Remove tags from an App Runner resource.
    
    Specified by:
    
    untagResource in interface AWSAppRunner
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateService
```
public UpdateServiceResult updateService(UpdateServiceRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Update an AWS 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.
    
    Specified by:
    
    updateService in interface AWSAppRunner
    
    Returns:
    
    Result of the UpdateService operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSAppRunner
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSAppRunner
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSAppRunner
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSAppRunner
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSAppRunner

Field Summary

Fields inherited from interface com.amazonaws.services.apprunner.AWSAppRunner

Method Summary

Methods inherited from class java.lang.Object

Method Detail

associateCustomDomain

createAutoScalingConfiguration

createConnection

createService

deleteAutoScalingConfiguration

deleteConnection

deleteService

describeAutoScalingConfiguration

describeCustomDomains

describeService

disassociateCustomDomain

listAutoScalingConfigurations

listConnections

listOperations

listServices

listTagsForResource

pauseService

resumeService

startDeployment

tagResource

untagResource

updateService

shutdown

getCachedResponseMetadata