Client

apprunner

R Documentation

AWS App Runner¶

Description¶

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.

Usage¶

apprunner(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- apprunner(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

associate_custom_domain: Associate your own domain name with the App Runner subdomain URL of your App Runner service
create_auto_scaling_configuration: Create an App Runner automatic scaling configuration resource
create_connection: Create an App Runner connection resource
create_observability_configuration: Create an App Runner observability configuration resource
create_service: Create an App Runner service
create_vpc_connector: Create an App Runner VPC connector resource
create_vpc_ingress_connection: Create an App Runner VPC Ingress Connection resource
delete_auto_scaling_configuration: Delete an App Runner automatic scaling configuration resource
delete_connection: Delete an App Runner connection
delete_observability_configuration: Delete an App Runner observability configuration resource
delete_service: Delete an App Runner service
delete_vpc_connector: Delete an App Runner VPC connector resource
delete_vpc_ingress_connection: Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service
describe_auto_scaling_configuration: Return a full description of an App Runner automatic scaling configuration resource
describe_custom_domains: Return a description of custom domain names that are associated with an App Runner service
describe_observability_configuration: Return a full description of an App Runner observability configuration resource
describe_service: Return a full description of an App Runner service
describe_vpc_connector: Return a description of an App Runner VPC connector resource
describe_vpc_ingress_connection: Return a full description of an App Runner VPC Ingress Connection resource
disassociate_custom_domain: Disassociate a custom domain name from an App Runner service
list_auto_scaling_configurations: Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account
list_connections: Returns a list of App Runner connections that are associated with your Amazon Web Services account
list_observability_configurations: Returns a list of active App Runner observability configurations in your Amazon Web Services account
list_operations: Return a list of operations that occurred on an App Runner service
list_services: Returns a list of running App Runner services in your Amazon Web Services account; Returns a list of the associated App Runner services using an auto scaling configuration
list_tags_for_resource: List tags that are associated with for an App Runner resource
list_vpc_connectors: Returns a list of App Runner VPC connectors in your Amazon Web Services account
list_vpc_ingress_connections: Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account
pause_service: Pause an active App Runner service
resume_service: Resume an active App Runner service
start_deployment: 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
tag_resource: Add tags to, or update the tag values of, an App Runner resource
untag_resource: Remove tags from an App Runner resource; Update an auto scaling configuration to be the default
update_service: Update an App Runner service
update_vpc_ingress_connection: Update an existing App Runner VPC Ingress Connection resource

Examples¶

## Not run: 
svc <- apprunner()
svc$associate_custom_domain(
  Foo = 123
)

## End(Not run)