@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSAppRunner extends Object implements AWSAppRunner
AWSAppRunner. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AssociateCustomDomainResult |
associateCustomDomain(AssociateCustomDomainRequest request)
Associate your own domain name with the App Runner subdomain URL of your App Runner service.
|
CreateAutoScalingConfigurationResult |
createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest request)
Create an App Runner automatic scaling configuration resource.
|
CreateConnectionResult |
createConnection(CreateConnectionRequest request)
Create an App Runner connection resource.
|
CreateObservabilityConfigurationResult |
createObservabilityConfiguration(CreateObservabilityConfigurationRequest request)
Create an App Runner observability configuration resource.
|
CreateServiceResult |
createService(CreateServiceRequest request)
Create an App Runner service.
|
CreateVpcConnectorResult |
createVpcConnector(CreateVpcConnectorRequest request)
Create an App Runner VPC connector resource.
|
CreateVpcIngressConnectionResult |
createVpcIngressConnection(CreateVpcIngressConnectionRequest request)
Create an App Runner VPC Ingress Connection resource.
|
DeleteAutoScalingConfigurationResult |
deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest request)
Delete an App Runner automatic scaling configuration resource.
|
DeleteConnectionResult |
deleteConnection(DeleteConnectionRequest request)
Delete an App Runner connection.
|
DeleteObservabilityConfigurationResult |
deleteObservabilityConfiguration(DeleteObservabilityConfigurationRequest request)
Delete an App Runner observability configuration resource.
|
DeleteServiceResult |
deleteService(DeleteServiceRequest request)
Delete an App Runner service.
|
DeleteVpcConnectorResult |
deleteVpcConnector(DeleteVpcConnectorRequest request)
Delete an App Runner VPC connector resource.
|
DeleteVpcIngressConnectionResult |
deleteVpcIngressConnection(DeleteVpcIngressConnectionRequest request)
Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service.
|
DescribeAutoScalingConfigurationResult |
describeAutoScalingConfiguration(DescribeAutoScalingConfigurationRequest request)
Return a full description of an App Runner automatic scaling configuration resource.
|
DescribeCustomDomainsResult |
describeCustomDomains(DescribeCustomDomainsRequest request)
Return a description of custom domain names that are associated with an App Runner service.
|
DescribeObservabilityConfigurationResult |
describeObservabilityConfiguration(DescribeObservabilityConfigurationRequest request)
Return a full description of an App Runner observability configuration resource.
|
DescribeServiceResult |
describeService(DescribeServiceRequest request)
Return a full description of an App Runner service.
|
DescribeVpcConnectorResult |
describeVpcConnector(DescribeVpcConnectorRequest request)
Return a description of an App Runner VPC connector resource.
|
DescribeVpcIngressConnectionResult |
describeVpcIngressConnection(DescribeVpcIngressConnectionRequest request)
Return a full description of an App Runner VPC Ingress Connection resource.
|
DisassociateCustomDomainResult |
disassociateCustomDomain(DisassociateCustomDomainRequest request)
Disassociate a custom domain name from an 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 active App Runner automatic scaling configurations in your Amazon Web Services account.
|
ListConnectionsResult |
listConnections(ListConnectionsRequest request)
Returns a list of App Runner connections that are associated with your Amazon Web Services account.
|
ListObservabilityConfigurationsResult |
listObservabilityConfigurations(ListObservabilityConfigurationsRequest request)
Returns a list of active App Runner observability configurations in your Amazon Web Services account.
|
ListOperationsResult |
listOperations(ListOperationsRequest request)
Return a list of operations that occurred on an App Runner service.
|
ListServicesResult |
listServices(ListServicesRequest request)
Returns a list of running App Runner services in your Amazon Web Services account.
|
ListServicesForAutoScalingConfigurationResult |
listServicesForAutoScalingConfiguration(ListServicesForAutoScalingConfigurationRequest request)
Returns a list of the associated App Runner services using an auto scaling configuration.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
List tags that are associated with for an App Runner resource.
|
ListVpcConnectorsResult |
listVpcConnectors(ListVpcConnectorsRequest request)
Returns a list of App Runner VPC connectors in your Amazon Web Services account.
|
ListVpcIngressConnectionsResult |
listVpcIngressConnections(ListVpcIngressConnectionsRequest request)
Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.
|
PauseServiceResult |
pauseService(PauseServiceRequest request)
Pause an active App Runner service.
|
ResumeServiceResult |
resumeService(ResumeServiceRequest request)
Resume an active 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 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.
|
UpdateDefaultAutoScalingConfigurationResult |
updateDefaultAutoScalingConfiguration(UpdateDefaultAutoScalingConfigurationRequest request)
Update an auto scaling configuration to be the default.
|
UpdateServiceResult |
updateService(UpdateServiceRequest request)
Update an App Runner service.
|
UpdateVpcIngressConnectionResult |
updateVpcIngressConnection(UpdateVpcIngressConnectionRequest request)
Update an existing App Runner VPC Ingress Connection resource.
|
public AssociateCustomDomainResult associateCustomDomain(AssociateCustomDomainRequest request)
AWSAppRunnerAssociate 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).
associateCustomDomain in interface AWSAppRunnerpublic CreateAutoScalingConfigurationResult createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest request)
AWSAppRunnerCreate 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.
createAutoScalingConfiguration in interface AWSAppRunnerpublic CreateConnectionResult createConnection(CreateConnectionRequest request)
AWSAppRunnerCreate 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.
createConnection in interface AWSAppRunnerpublic CreateObservabilityConfigurationResult createObservabilityConfiguration(CreateObservabilityConfigurationRequest request)
AWSAppRunnerCreate 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.
createObservabilityConfiguration in interface AWSAppRunnerpublic CreateServiceResult createService(CreateServiceRequest request)
AWSAppRunnerCreate 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.
createService in interface AWSAppRunnerpublic CreateVpcConnectorResult createVpcConnector(CreateVpcConnectorRequest request)
AWSAppRunnerCreate 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).
createVpcConnector in interface AWSAppRunnerpublic CreateVpcIngressConnectionResult createVpcIngressConnection(CreateVpcIngressConnectionRequest request)
AWSAppRunnerCreate 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.
createVpcIngressConnection in interface AWSAppRunnerpublic DeleteAutoScalingConfigurationResult deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest request)
AWSAppRunnerDelete 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.
deleteAutoScalingConfiguration in interface AWSAppRunnerpublic DeleteConnectionResult deleteConnection(DeleteConnectionRequest request)
AWSAppRunner
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.
deleteConnection in interface AWSAppRunnerpublic DeleteObservabilityConfigurationResult deleteObservabilityConfiguration(DeleteObservabilityConfigurationRequest request)
AWSAppRunnerDelete 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.
deleteObservabilityConfiguration in interface AWSAppRunnerpublic DeleteServiceResult deleteService(DeleteServiceRequest request)
AWSAppRunnerDelete 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.
Make sure that you don't have any active VPCIngressConnections associated with the service you want to delete.
deleteService in interface AWSAppRunnerpublic DeleteVpcConnectorResult deleteVpcConnector(DeleteVpcConnectorRequest request)
AWSAppRunnerDelete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services.
deleteVpcConnector in interface AWSAppRunnerpublic DeleteVpcIngressConnectionResult deleteVpcIngressConnection(DeleteVpcIngressConnectionRequest request)
AWSAppRunnerDelete 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
deleteVpcIngressConnection in interface AWSAppRunnerpublic DescribeAutoScalingConfigurationResult describeAutoScalingConfiguration(DescribeAutoScalingConfigurationRequest request)
AWSAppRunnerReturn a full description of an App Runner automatic scaling configuration resource.
describeAutoScalingConfiguration in interface AWSAppRunnerpublic DescribeCustomDomainsResult describeCustomDomains(DescribeCustomDomainsRequest request)
AWSAppRunnerReturn a description of custom domain names that are associated with an App Runner service.
describeCustomDomains in interface AWSAppRunnerpublic DescribeObservabilityConfigurationResult describeObservabilityConfiguration(DescribeObservabilityConfigurationRequest request)
AWSAppRunnerReturn a full description of an App Runner observability configuration resource.
describeObservabilityConfiguration in interface AWSAppRunnerpublic DescribeServiceResult describeService(DescribeServiceRequest request)
AWSAppRunnerReturn a full description of an App Runner service.
describeService in interface AWSAppRunnerpublic DescribeVpcConnectorResult describeVpcConnector(DescribeVpcConnectorRequest request)
AWSAppRunnerReturn a description of an App Runner VPC connector resource.
describeVpcConnector in interface AWSAppRunnerpublic DescribeVpcIngressConnectionResult describeVpcIngressConnection(DescribeVpcIngressConnectionRequest request)
AWSAppRunnerReturn a full description of an App Runner VPC Ingress Connection resource.
describeVpcIngressConnection in interface AWSAppRunnerpublic DisassociateCustomDomainResult disassociateCustomDomain(DisassociateCustomDomainRequest request)
AWSAppRunnerDisassociate 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.
disassociateCustomDomain in interface AWSAppRunnerpublic ListAutoScalingConfigurationsResult listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request)
AWSAppRunnerReturns 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.
listAutoScalingConfigurations in interface AWSAppRunnerpublic ListConnectionsResult listConnections(ListConnectionsRequest request)
AWSAppRunnerReturns a list of App Runner connections that are associated with your Amazon Web Services account.
listConnections in interface AWSAppRunnerpublic ListObservabilityConfigurationsResult listObservabilityConfigurations(ListObservabilityConfigurationsRequest request)
AWSAppRunnerReturns 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.
listObservabilityConfigurations in interface AWSAppRunnerpublic ListOperationsResult listOperations(ListOperationsRequest request)
AWSAppRunnerReturn 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.
listOperations in interface AWSAppRunnerpublic ListServicesResult listServices(ListServicesRequest request)
AWSAppRunnerReturns a list of running App Runner services in your Amazon Web Services account.
listServices in interface AWSAppRunnerpublic ListServicesForAutoScalingConfigurationResult listServicesForAutoScalingConfiguration(ListServicesForAutoScalingConfigurationRequest request)
AWSAppRunnerReturns a list of the associated App Runner services using an auto scaling configuration.
listServicesForAutoScalingConfiguration in interface AWSAppRunnerpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSAppRunnerList tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs.
listTagsForResource in interface AWSAppRunnerpublic ListVpcConnectorsResult listVpcConnectors(ListVpcConnectorsRequest request)
AWSAppRunnerReturns a list of App Runner VPC connectors in your Amazon Web Services account.
listVpcConnectors in interface AWSAppRunnerpublic ListVpcIngressConnectionsResult listVpcIngressConnections(ListVpcIngressConnectionsRequest request)
AWSAppRunnerReturn a list of App Runner VPC Ingress Connections in your Amazon Web Services account.
listVpcIngressConnections in interface AWSAppRunnerpublic PauseServiceResult pauseService(PauseServiceRequest request)
AWSAppRunnerPause 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.
pauseService in interface AWSAppRunnerpublic ResumeServiceResult resumeService(ResumeServiceRequest request)
AWSAppRunnerResume 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.
resumeService in interface AWSAppRunnerpublic StartDeploymentResult startDeployment(StartDeploymentRequest request)
AWSAppRunnerInitiate 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.
startDeployment in interface AWSAppRunnerpublic TagResourceResult tagResource(TagResourceRequest request)
AWSAppRunnerAdd tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.
tagResource in interface AWSAppRunnerpublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSAppRunnerRemove tags from an App Runner resource.
untagResource in interface AWSAppRunnerpublic UpdateDefaultAutoScalingConfigurationResult updateDefaultAutoScalingConfiguration(UpdateDefaultAutoScalingConfigurationRequest request)
AWSAppRunnerUpdate an auto scaling configuration to be the default. The existing default auto scaling configuration will be set to non-default automatically.
updateDefaultAutoScalingConfiguration in interface AWSAppRunnerpublic UpdateServiceResult updateService(UpdateServiceRequest request)
AWSAppRunnerUpdate 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.
updateService in interface AWSAppRunnerpublic UpdateVpcIngressConnectionResult updateVpcIngressConnection(UpdateVpcIngressConnectionRequest request)
AWSAppRunnerUpdate 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
updateVpcIngressConnection in interface AWSAppRunnerpublic void shutdown()
AWSAppRunnershutdown in interface AWSAppRunnerpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSAppRunnerResponse 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.
getCachedResponseMetadata in interface AWSAppRunnerrequest - The originally executed request.