AppRunner

import { AppRunner } from "https://aws-api.deno.dev/v0.3/services/apprunner.ts?docs=full";

class AppRunner {

constructor(apiFactory: client.ApiFactory);

async associateCustomDomain(params: AssociateCustomDomainRequest, opts?: client.RequestOptions): Promise<AssociateCustomDomainResponse>;

async createAutoScalingConfiguration(params: CreateAutoScalingConfigurationRequest, opts?: client.RequestOptions): Promise<CreateAutoScalingConfigurationResponse>;

async createConnection(params: CreateConnectionRequest, opts?: client.RequestOptions): Promise<CreateConnectionResponse>;

async createService(params: CreateServiceRequest, opts?: client.RequestOptions): Promise<CreateServiceResponse>;

async deleteAutoScalingConfiguration(params: DeleteAutoScalingConfigurationRequest, opts?: client.RequestOptions): Promise<DeleteAutoScalingConfigurationResponse>;

async deleteConnection(params: DeleteConnectionRequest, opts?: client.RequestOptions): Promise<DeleteConnectionResponse>;

async deleteService(params: DeleteServiceRequest, opts?: client.RequestOptions): Promise<DeleteServiceResponse>;

async describeAutoScalingConfiguration(params: DescribeAutoScalingConfigurationRequest, opts?: client.RequestOptions): Promise<DescribeAutoScalingConfigurationResponse>;

async describeCustomDomains(params: DescribeCustomDomainsRequest, opts?: client.RequestOptions): Promise<DescribeCustomDomainsResponse>;

async describeService(params: DescribeServiceRequest, opts?: client.RequestOptions): Promise<DescribeServiceResponse>;

async disassociateCustomDomain(params: DisassociateCustomDomainRequest, opts?: client.RequestOptions): Promise<DisassociateCustomDomainResponse>;

async listAutoScalingConfigurations(params?: ListAutoScalingConfigurationsRequest, opts?: client.RequestOptions): Promise<ListAutoScalingConfigurationsResponse>;

async listConnections(params?: ListConnectionsRequest, opts?: client.RequestOptions): Promise<ListConnectionsResponse>;

async listOperations(params: ListOperationsRequest, opts?: client.RequestOptions): Promise<ListOperationsResponse>;

async listServices(params?: ListServicesRequest, opts?: client.RequestOptions): Promise<ListServicesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async pauseService(params: PauseServiceRequest, opts?: client.RequestOptions): Promise<PauseServiceResponse>;

async resumeService(params: ResumeServiceRequest, opts?: client.RequestOptions): Promise<ResumeServiceResponse>;

async startDeployment(params: StartDeploymentRequest, opts?: client.RequestOptions): Promise<StartDeploymentResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateService(params: UpdateServiceRequest, opts?: client.RequestOptions): Promise<UpdateServiceResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new AppRunner(apiFactory: client.ApiFactory)

[src]

§Methods

associateCustomDomain(params: AssociateCustomDomainRequest, opts?: client.RequestOptions): Promise<AssociateCustomDomainResponse>

[src]

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).

createAutoScalingConfiguration(params: CreateAutoScalingConfigurationRequest, opts?: client.RequestOptions): Promise<CreateAutoScalingConfigurationResponse>

[src]

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.

createConnection(params: CreateConnectionRequest, opts?: client.RequestOptions): Promise<CreateConnectionResponse>

[src]

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.

createService(params: CreateServiceRequest, opts?: client.RequestOptions): Promise<CreateServiceResponse>

[src]

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.

deleteAutoScalingConfiguration(params: DeleteAutoScalingConfigurationRequest, opts?: client.RequestOptions): Promise<DeleteAutoScalingConfigurationResponse>

[src]

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.

deleteConnection(params: DeleteConnectionRequest, opts?: client.RequestOptions): Promise<DeleteConnectionResponse>

[src]

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.

deleteService(params: DeleteServiceRequest, opts?: client.RequestOptions): Promise<DeleteServiceResponse>

[src]

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.

describeAutoScalingConfiguration(params: DescribeAutoScalingConfigurationRequest, opts?: client.RequestOptions): Promise<DescribeAutoScalingConfigurationResponse>

[src]

Return a full description of an App Runner automatic scaling configuration resource.

describeCustomDomains(params: DescribeCustomDomainsRequest, opts?: client.RequestOptions): Promise<DescribeCustomDomainsResponse>

[src]

Return a description of custom domain names that are associated with an App Runner service.

describeService(params: DescribeServiceRequest, opts?: client.RequestOptions): Promise<DescribeServiceResponse>

[src]

Return a full description of an App Runner service.

disassociateCustomDomain(params: DisassociateCustomDomainRequest, opts?: client.RequestOptions): Promise<DisassociateCustomDomainResponse>

[src]

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.

listAutoScalingConfigurations(params?: ListAutoScalingConfigurationsRequest, opts?: client.RequestOptions): Promise<ListAutoScalingConfigurationsResponse>

[src]

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.

listConnections(params?: ListConnectionsRequest, opts?: client.RequestOptions): Promise<ListConnectionsResponse>

[src]

Returns a list of App Runner connections that are associated with your Amazon Web Services account.

listOperations(params: ListOperationsRequest, opts?: client.RequestOptions): Promise<ListOperationsResponse>

[src]

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.

listServices(params?: ListServicesRequest, opts?: client.RequestOptions): Promise<ListServicesResponse>

[src]

Returns a list of running App Runner services in your Amazon Web Services account.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs.

pauseService(params: PauseServiceRequest, opts?: client.RequestOptions): Promise<PauseServiceResponse>

[src]

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.

resumeService(params: ResumeServiceRequest, opts?: client.RequestOptions): Promise<ResumeServiceResponse>

[src]

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.

startDeployment(params: StartDeploymentRequest, opts?: client.RequestOptions): Promise<StartDeploymentResponse>

[src]

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.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Remove tags from an App Runner resource.

updateService(params: UpdateServiceRequest, opts?: client.RequestOptions): Promise<UpdateServiceResponse>

[src]

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]