apprunner/aws.sdk.kotlin.services.apprunner/AppRunnerClient

AppRunnerClient

App Runner

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<AppRunnerClient.Config, AppRunnerClient.Config.Builder, AppRunnerClient>

Companion

object Companion : AbstractAwsSdkClientFactory<AppRunnerClient.Config, AppRunnerClient.Config.Builder, AppRunnerClient, AppRunnerClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: AppRunnerClient.Config

AppRunnerClient's configuration

Functions

associateCustomDomain

abstract suspend fun associateCustomDomain(input: AssociateCustomDomainRequest): AssociateCustomDomainResponse

Associate your own domain name with the App Runner subdomain URL of your App Runner service.

createAutoScalingConfiguration

abstract suspend fun createAutoScalingConfiguration(input: CreateAutoScalingConfigurationRequest): CreateAutoScalingConfigurationResponse

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.

createConnection

abstract suspend fun createConnection(input: CreateConnectionRequest): CreateConnectionResponse

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.

createObservabilityConfiguration

abstract suspend fun createObservabilityConfiguration(input: CreateObservabilityConfigurationRequest): CreateObservabilityConfigurationResponse

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.

createService

abstract suspend fun createService(input: CreateServiceRequest): CreateServiceResponse

Create an App Runner service. After the service is created, the action also automatically starts a deployment.

createVpcConnector

abstract suspend fun createVpcConnector(input: CreateVpcConnectorRequest): CreateVpcConnectorResponse

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

createVpcIngressConnection

abstract suspend fun createVpcIngressConnection(input: CreateVpcIngressConnectionRequest): CreateVpcIngressConnectionResponse

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.

deleteAutoScalingConfiguration

abstract suspend fun deleteAutoScalingConfiguration(input: DeleteAutoScalingConfigurationRequest): DeleteAutoScalingConfigurationResponse

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.

deleteConnection

abstract suspend fun deleteConnection(input: DeleteConnectionRequest): DeleteConnectionResponse

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.

deleteObservabilityConfiguration

abstract suspend fun deleteObservabilityConfiguration(input: DeleteObservabilityConfigurationRequest): DeleteObservabilityConfigurationResponse

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.

deleteService

abstract suspend fun deleteService(input: DeleteServiceRequest): DeleteServiceResponse

Delete an App Runner service.

deleteVpcConnector

abstract suspend fun deleteVpcConnector(input: DeleteVpcConnectorRequest): DeleteVpcConnectorResponse

Delete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services.

deleteVpcIngressConnection

abstract suspend fun deleteVpcIngressConnection(input: DeleteVpcIngressConnectionRequest): DeleteVpcIngressConnectionResponse

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:

describeAutoScalingConfiguration

abstract suspend fun describeAutoScalingConfiguration(input: DescribeAutoScalingConfigurationRequest): DescribeAutoScalingConfigurationResponse

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

describeCustomDomains

abstract suspend fun describeCustomDomains(input: DescribeCustomDomainsRequest): DescribeCustomDomainsResponse

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

describeObservabilityConfiguration

abstract suspend fun describeObservabilityConfiguration(input: DescribeObservabilityConfigurationRequest): DescribeObservabilityConfigurationResponse

Return a full description of an App Runner observability configuration resource.

describeService

abstract suspend fun describeService(input: DescribeServiceRequest): DescribeServiceResponse

Return a full description of an App Runner service.

describeVpcConnector

abstract suspend fun describeVpcConnector(input: DescribeVpcConnectorRequest): DescribeVpcConnectorResponse

Return a description of an App Runner VPC connector resource.

describeVpcIngressConnection

abstract suspend fun describeVpcIngressConnection(input: DescribeVpcIngressConnectionRequest): DescribeVpcIngressConnectionResponse

Return a full description of an App Runner VPC Ingress Connection resource.

disassociateCustomDomain

abstract suspend fun disassociateCustomDomain(input: DisassociateCustomDomainRequest): DisassociateCustomDomainResponse

Disassociate a custom domain name from an App Runner service.

listAutoScalingConfigurations

abstract suspend fun listAutoScalingConfigurations(input: ListAutoScalingConfigurationsRequest = ListAutoScalingConfigurationsRequest { }): ListAutoScalingConfigurationsResponse

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.

listConnections

abstract suspend fun listConnections(input: ListConnectionsRequest = ListConnectionsRequest { }): ListConnectionsResponse

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

listObservabilityConfigurations

abstract suspend fun listObservabilityConfigurations(input: ListObservabilityConfigurationsRequest = ListObservabilityConfigurationsRequest { }): ListObservabilityConfigurationsResponse

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.

listOperations

abstract suspend fun listOperations(input: ListOperationsRequest): ListOperationsResponse

Return a list of operations that occurred on an App Runner service.

listServices

abstract suspend fun listServices(input: ListServicesRequest = ListServicesRequest { }): ListServicesResponse

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

listServicesForAutoScalingConfiguration

abstract suspend fun listServicesForAutoScalingConfiguration(input: ListServicesForAutoScalingConfigurationRequest): ListServicesForAutoScalingConfigurationResponse

Returns a list of the associated App Runner services using an auto scaling configuration.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

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

listVpcConnectors

abstract suspend fun listVpcConnectors(input: ListVpcConnectorsRequest = ListVpcConnectorsRequest { }): ListVpcConnectorsResponse

Returns a list of App Runner VPC connectors in your Amazon Web Services account.

listVpcIngressConnections

abstract suspend fun listVpcIngressConnections(input: ListVpcIngressConnectionsRequest = ListVpcIngressConnectionsRequest { }): ListVpcIngressConnectionsResponse

Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.

pauseService

abstract suspend fun pauseService(input: PauseServiceRequest): PauseServiceResponse

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

resumeService

abstract suspend fun resumeService(input: ResumeServiceRequest): ResumeServiceResponse

Resume an active App Runner service. App Runner provisions compute capacity for the service.

startDeployment

abstract suspend fun startDeployment(input: StartDeploymentRequest): StartDeploymentResponse

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.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Remove tags from an App Runner resource.

updateDefaultAutoScalingConfiguration

abstract suspend fun updateDefaultAutoScalingConfiguration(input: UpdateDefaultAutoScalingConfigurationRequest): UpdateDefaultAutoScalingConfigurationResponse

Update an auto scaling configuration to be the default. The existing default auto scaling configuration will be set to non-default automatically.

updateService

abstract suspend fun updateService(input: UpdateServiceRequest): UpdateServiceResponse

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.

updateVpcIngressConnection

abstract suspend fun updateVpcIngressConnection(input: UpdateVpcIngressConnectionRequest): UpdateVpcIngressConnectionResponse

Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated:

Inherited functions

associateCustomDomain

inline suspend fun AppRunnerClient.associateCustomDomain(crossinline block: AssociateCustomDomainRequest.Builder.() -> Unit): AssociateCustomDomainResponse

Associate your own domain name with the App Runner subdomain URL of your App Runner service.

expect abstract fun close()

createAutoScalingConfiguration

inline suspend fun AppRunnerClient.createAutoScalingConfiguration(crossinline block: CreateAutoScalingConfigurationRequest.Builder.() -> Unit): CreateAutoScalingConfigurationResponse

createConnection

inline suspend fun AppRunnerClient.createConnection(crossinline block: CreateConnectionRequest.Builder.() -> Unit): CreateConnectionResponse

createObservabilityConfiguration

inline suspend fun AppRunnerClient.createObservabilityConfiguration(crossinline block: CreateObservabilityConfigurationRequest.Builder.() -> Unit): CreateObservabilityConfigurationResponse

createService

inline suspend fun AppRunnerClient.createService(crossinline block: CreateServiceRequest.Builder.() -> Unit): CreateServiceResponse

Create an App Runner service. After the service is created, the action also automatically starts a deployment.

createVpcConnector

inline suspend fun AppRunnerClient.createVpcConnector(crossinline block: CreateVpcConnectorRequest.Builder.() -> Unit): CreateVpcConnectorResponse

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

createVpcIngressConnection

inline suspend fun AppRunnerClient.createVpcIngressConnection(crossinline block: CreateVpcIngressConnectionRequest.Builder.() -> Unit): CreateVpcIngressConnectionResponse

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.

deleteAutoScalingConfiguration

inline suspend fun AppRunnerClient.deleteAutoScalingConfiguration(crossinline block: DeleteAutoScalingConfigurationRequest.Builder.() -> Unit): DeleteAutoScalingConfigurationResponse

deleteConnection

inline suspend fun AppRunnerClient.deleteConnection(crossinline block: DeleteConnectionRequest.Builder.() -> Unit): DeleteConnectionResponse

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.

deleteObservabilityConfiguration

inline suspend fun AppRunnerClient.deleteObservabilityConfiguration(crossinline block: DeleteObservabilityConfigurationRequest.Builder.() -> Unit): DeleteObservabilityConfigurationResponse

deleteService

inline suspend fun AppRunnerClient.deleteService(crossinline block: DeleteServiceRequest.Builder.() -> Unit): DeleteServiceResponse

Delete an App Runner service.

deleteVpcConnector

inline suspend fun AppRunnerClient.deleteVpcConnector(crossinline block: DeleteVpcConnectorRequest.Builder.() -> Unit): DeleteVpcConnectorResponse

Delete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services.

deleteVpcIngressConnection

inline suspend fun AppRunnerClient.deleteVpcIngressConnection(crossinline block: DeleteVpcIngressConnectionRequest.Builder.() -> Unit): DeleteVpcIngressConnectionResponse

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:

describeAutoScalingConfiguration

inline suspend fun AppRunnerClient.describeAutoScalingConfiguration(crossinline block: DescribeAutoScalingConfigurationRequest.Builder.() -> Unit): DescribeAutoScalingConfigurationResponse

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

describeCustomDomains

inline suspend fun AppRunnerClient.describeCustomDomains(crossinline block: DescribeCustomDomainsRequest.Builder.() -> Unit): DescribeCustomDomainsResponse

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

describeCustomDomainsPaginated

fun AppRunnerClient.describeCustomDomainsPaginated(initialRequest: DescribeCustomDomainsRequest): Flow<DescribeCustomDomainsResponse>

fun AppRunnerClient.describeCustomDomainsPaginated(block: DescribeCustomDomainsRequest.Builder.() -> Unit): Flow<DescribeCustomDomainsResponse>

Paginate over DescribeCustomDomainsResponse results.

describeObservabilityConfiguration

inline suspend fun AppRunnerClient.describeObservabilityConfiguration(crossinline block: DescribeObservabilityConfigurationRequest.Builder.() -> Unit): DescribeObservabilityConfigurationResponse

Return a full description of an App Runner observability configuration resource.

describeService

inline suspend fun AppRunnerClient.describeService(crossinline block: DescribeServiceRequest.Builder.() -> Unit): DescribeServiceResponse

Return a full description of an App Runner service.

describeVpcConnector

inline suspend fun AppRunnerClient.describeVpcConnector(crossinline block: DescribeVpcConnectorRequest.Builder.() -> Unit): DescribeVpcConnectorResponse

Return a description of an App Runner VPC connector resource.

describeVpcIngressConnection

inline suspend fun AppRunnerClient.describeVpcIngressConnection(crossinline block: DescribeVpcIngressConnectionRequest.Builder.() -> Unit): DescribeVpcIngressConnectionResponse

Return a full description of an App Runner VPC Ingress Connection resource.

disassociateCustomDomain

inline suspend fun AppRunnerClient.disassociateCustomDomain(crossinline block: DisassociateCustomDomainRequest.Builder.() -> Unit): DisassociateCustomDomainResponse

Disassociate a custom domain name from an App Runner service.

listAutoScalingConfigurations

inline suspend fun AppRunnerClient.listAutoScalingConfigurations(crossinline block: ListAutoScalingConfigurationsRequest.Builder.() -> Unit): ListAutoScalingConfigurationsResponse

listAutoScalingConfigurationsPaginated

fun AppRunnerClient.listAutoScalingConfigurationsPaginated(initialRequest: ListAutoScalingConfigurationsRequest = ListAutoScalingConfigurationsRequest { }): Flow<ListAutoScalingConfigurationsResponse>

fun AppRunnerClient.listAutoScalingConfigurationsPaginated(block: ListAutoScalingConfigurationsRequest.Builder.() -> Unit): Flow<ListAutoScalingConfigurationsResponse>

Paginate over ListAutoScalingConfigurationsResponse results.

listConnections

inline suspend fun AppRunnerClient.listConnections(crossinline block: ListConnectionsRequest.Builder.() -> Unit): ListConnectionsResponse

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

listConnectionsPaginated

fun AppRunnerClient.listConnectionsPaginated(initialRequest: ListConnectionsRequest = ListConnectionsRequest { }): Flow<ListConnectionsResponse>

fun AppRunnerClient.listConnectionsPaginated(block: ListConnectionsRequest.Builder.() -> Unit): Flow<ListConnectionsResponse>

Paginate over ListConnectionsResponse results.

listObservabilityConfigurations

inline suspend fun AppRunnerClient.listObservabilityConfigurations(crossinline block: ListObservabilityConfigurationsRequest.Builder.() -> Unit): ListObservabilityConfigurationsResponse

listObservabilityConfigurationsPaginated

fun AppRunnerClient.listObservabilityConfigurationsPaginated(initialRequest: ListObservabilityConfigurationsRequest = ListObservabilityConfigurationsRequest { }): Flow<ListObservabilityConfigurationsResponse>

fun AppRunnerClient.listObservabilityConfigurationsPaginated(block: ListObservabilityConfigurationsRequest.Builder.() -> Unit): Flow<ListObservabilityConfigurationsResponse>

Paginate over ListObservabilityConfigurationsResponse results.

listOperations

inline suspend fun AppRunnerClient.listOperations(crossinline block: ListOperationsRequest.Builder.() -> Unit): ListOperationsResponse

Return a list of operations that occurred on an App Runner service.

listOperationsPaginated

fun AppRunnerClient.listOperationsPaginated(initialRequest: ListOperationsRequest): Flow<ListOperationsResponse>

fun AppRunnerClient.listOperationsPaginated(block: ListOperationsRequest.Builder.() -> Unit): Flow<ListOperationsResponse>

Paginate over ListOperationsResponse results.

listServices

inline suspend fun AppRunnerClient.listServices(crossinline block: ListServicesRequest.Builder.() -> Unit): ListServicesResponse

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

listServicesForAutoScalingConfiguration

inline suspend fun AppRunnerClient.listServicesForAutoScalingConfiguration(crossinline block: ListServicesForAutoScalingConfigurationRequest.Builder.() -> Unit): ListServicesForAutoScalingConfigurationResponse

Returns a list of the associated App Runner services using an auto scaling configuration.

listServicesForAutoScalingConfigurationPaginated

fun AppRunnerClient.listServicesForAutoScalingConfigurationPaginated(initialRequest: ListServicesForAutoScalingConfigurationRequest): Flow<ListServicesForAutoScalingConfigurationResponse>

fun AppRunnerClient.listServicesForAutoScalingConfigurationPaginated(block: ListServicesForAutoScalingConfigurationRequest.Builder.() -> Unit): Flow<ListServicesForAutoScalingConfigurationResponse>

Paginate over ListServicesForAutoScalingConfigurationResponse results.

listServicesPaginated

fun AppRunnerClient.listServicesPaginated(initialRequest: ListServicesRequest = ListServicesRequest { }): Flow<ListServicesResponse>

fun AppRunnerClient.listServicesPaginated(block: ListServicesRequest.Builder.() -> Unit): Flow<ListServicesResponse>

Paginate over ListServicesResponse results.

listTagsForResource

inline suspend fun AppRunnerClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

listVpcConnectors

inline suspend fun AppRunnerClient.listVpcConnectors(crossinline block: ListVpcConnectorsRequest.Builder.() -> Unit): ListVpcConnectorsResponse

Returns a list of App Runner VPC connectors in your Amazon Web Services account.

listVpcConnectorsPaginated

fun AppRunnerClient.listVpcConnectorsPaginated(initialRequest: ListVpcConnectorsRequest = ListVpcConnectorsRequest { }): Flow<ListVpcConnectorsResponse>

fun AppRunnerClient.listVpcConnectorsPaginated(block: ListVpcConnectorsRequest.Builder.() -> Unit): Flow<ListVpcConnectorsResponse>

Paginate over ListVpcConnectorsResponse results.

listVpcIngressConnections

inline suspend fun AppRunnerClient.listVpcIngressConnections(crossinline block: ListVpcIngressConnectionsRequest.Builder.() -> Unit): ListVpcIngressConnectionsResponse

Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.

listVpcIngressConnectionsPaginated

fun AppRunnerClient.listVpcIngressConnectionsPaginated(initialRequest: ListVpcIngressConnectionsRequest = ListVpcIngressConnectionsRequest { }): Flow<ListVpcIngressConnectionsResponse>

fun AppRunnerClient.listVpcIngressConnectionsPaginated(block: ListVpcIngressConnectionsRequest.Builder.() -> Unit): Flow<ListVpcIngressConnectionsResponse>

Paginate over ListVpcIngressConnectionsResponse results.

pauseService

inline suspend fun AppRunnerClient.pauseService(crossinline block: PauseServiceRequest.Builder.() -> Unit): PauseServiceResponse

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

resumeService

inline suspend fun AppRunnerClient.resumeService(crossinline block: ResumeServiceRequest.Builder.() -> Unit): ResumeServiceResponse

Resume an active App Runner service. App Runner provisions compute capacity for the service.

startDeployment

inline suspend fun AppRunnerClient.startDeployment(crossinline block: StartDeploymentRequest.Builder.() -> Unit): StartDeploymentResponse

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.

tagResource

inline suspend fun AppRunnerClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

untagResource

inline suspend fun AppRunnerClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Remove tags from an App Runner resource.

updateDefaultAutoScalingConfiguration

inline suspend fun AppRunnerClient.updateDefaultAutoScalingConfiguration(crossinline block: UpdateDefaultAutoScalingConfigurationRequest.Builder.() -> Unit): UpdateDefaultAutoScalingConfigurationResponse

Update an auto scaling configuration to be the default. The existing default auto scaling configuration will be set to non-default automatically.

updateService

inline suspend fun AppRunnerClient.updateService(crossinline block: UpdateServiceRequest.Builder.() -> Unit): UpdateServiceResponse

updateVpcIngressConnection

inline suspend fun AppRunnerClient.updateVpcIngressConnection(crossinline block: UpdateVpcIngressConnectionRequest.Builder.() -> Unit): UpdateVpcIngressConnectionResponse

Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated:

withConfig

fun AppRunnerClient.withConfig(block: AppRunnerClient.Config.Builder.() -> Unit): AppRunnerClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.