Class: Aws::AppRunner::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-apprunner/client.rb

Overview

An API client for AppRunner. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::AppRunner::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::AppRunner::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::AppRunner::EndpointParameters`

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



441
442
443
 
# File 'lib/aws-sdk-apprunner/client.rb', line 441

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2981
2982
2983
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2981

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2984
2985
2986
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2984

def errors_module
  Errors
end

Instance Method Details

#associate_custom_domain(params = {}) ⇒ Types::AssociateCustomDomainResponse

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

[1]: docs.aws.amazon.com/acm/latest/userguide

Examples:

Request syntax with placeholder values


resp = client.associate_custom_domain({
  service_arn: "AppRunnerResourceArn", # required
  domain_name: "DomainName", # required
  enable_www_subdomain: false,
})

Response structure


resp.dns_target #=> String
resp.service_arn #=> String
resp.custom_domain.domain_name #=> String
resp.custom_domain.enable_www_subdomain #=> Boolean
resp.custom_domain.certificate_validation_records #=> Array
resp.custom_domain.certificate_validation_records[0].name #=> String
resp.custom_domain.certificate_validation_records[0].type #=> String
resp.custom_domain.certificate_validation_records[0].value #=> String
resp.custom_domain.certificate_validation_records[0].status #=> String, one of "PENDING_VALIDATION", "SUCCESS", "FAILED"
resp.custom_domain.status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETE_FAILED", "PENDING_CERTIFICATE_DNS_VALIDATION", "BINDING_CERTIFICATE"
resp.vpc_dns_targets #=> Array
resp.vpc_dns_targets[0].vpc_ingress_connection_arn #=> String
resp.vpc_dns_targets[0].vpc_id #=> String
resp.vpc_dns_targets[0].domain_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.

  • :domain_name (required, String) —

    A custom domain endpoint to associate. Specify a root domain (for example, ‘example.com`), a subdomain (for example, `login.example.com` or `admin.login.example.com`), or a wildcard (for example, `*.example.com`).

  • :enable_www_subdomain (Boolean) —

    Set to ‘true` to associate the subdomain `www.DomainName ` with the App Runner service in addition to the base domain.

    Default: ‘true`

Returns:

See Also:



515
516
517
518
 
# File 'lib/aws-sdk-apprunner/client.rb', line 515

def associate_custom_domain(params = {}, options = {})
  req = build_request(:associate_custom_domain, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2954

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::AppRunner')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-apprunner'
  context[:gem_version] = '1.45.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_auto_scaling_configuration(params = {}) ⇒ Types::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.

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.

Examples:

Request syntax with placeholder values


resp = client.create_auto_scaling_configuration({
  auto_scaling_configuration_name: "AutoScalingConfigurationName", # required
  max_concurrency: 1,
  min_size: 1,
  max_size: 1,
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.auto_scaling_configuration.auto_scaling_configuration_arn #=> String
resp.auto_scaling_configuration.auto_scaling_configuration_name #=> String
resp.auto_scaling_configuration.auto_scaling_configuration_revision #=> Integer
resp.auto_scaling_configuration.latest #=> Boolean
resp.auto_scaling_configuration.status #=> String, one of "ACTIVE", "INACTIVE"
resp.auto_scaling_configuration.max_concurrency #=> Integer
resp.auto_scaling_configuration.min_size #=> Integer
resp.auto_scaling_configuration.max_size #=> Integer
resp.auto_scaling_configuration.created_at #=> Time
resp.auto_scaling_configuration.deleted_at #=> Time
resp.auto_scaling_configuration.has_associated_service #=> Boolean
resp.auto_scaling_configuration.is_default #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_configuration_name (required, String) —

    A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number ‘1` of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

    <note markdown=“1”> Prior to the release of [Auto scale configuration enhancements], the name ‘DefaultConfiguration` was reserved.

    This restriction is no longer in place. You can now manage

    ‘DefaultConfiguration` the same way you manage your custom auto scaling configurations. This means you can do the following with the `DefaultConfiguration` that App Runner provides:

    * Create new revisions of the `DefaultConfiguration`.

    • Delete the revisions of the ‘DefaultConfiguration`.

    • Delete the auto scaling configuration for which the App Runner ‘DefaultConfiguration` was created.

    • If you delete the auto scaling configuration you can create another custom auto scaling configuration with the same ‘DefaultConfiguration` name. The original `DefaultConfiguration` resource provided by App Runner remains in your account unless you make changes to it.

    </note>

    [1]: docs.aws.amazon.com/apprunner/latest/relnotes/release-2023-09-22-auto-scale-config.html

  • :max_concurrency (Integer) —

    The maximum number of concurrent requests that you want an instance to process. If the number of concurrent requests exceeds this limit, App Runner scales up your service.

    Default: ‘100`

  • :min_size (Integer) —

    The minimum number of instances that App Runner provisions for your service. The service always has at least ‘MinSize` provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.

    App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.

    Default: ‘1`

  • :max_size (Integer) —

    The maximum number of instances that your service scales up to. At most ‘MaxSize` instances actively serve traffic for your service.

    Default: ‘25`

  • :tags (Array<Types::Tag>) —

    A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.

Returns:

See Also:



644
645
646
647
 
# File 'lib/aws-sdk-apprunner/client.rb', line 644

def create_auto_scaling_configuration(params = {}, options = {})
  req = build_request(:create_auto_scaling_configuration, params)
  req.send_request(options)
end

#create_connection(params = {}) ⇒ Types::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.

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.

Examples:

Request syntax with placeholder values


resp = client.create_connection({
  connection_name: "ConnectionName", # required
  provider_type: "GITHUB", # required, accepts GITHUB, BITBUCKET
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.connection.connection_name #=> String
resp.connection.connection_arn #=> String
resp.connection.provider_type #=> String, one of "GITHUB", "BITBUCKET"
resp.connection.status #=> String, one of "PENDING_HANDSHAKE", "AVAILABLE", "ERROR", "DELETED"
resp.connection.created_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :connection_name (required, String) —

    A name for the new connection. It must be unique across all App Runner connections for the Amazon Web Services account in the Amazon Web Services Region.

  • :provider_type (required, String) —

    The source repository provider.

  • :tags (Array<Types::Tag>) —

    A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.

Returns:

See Also:



699
700
701
702
 
# File 'lib/aws-sdk-apprunner/client.rb', line 699

def create_connection(params = {}, options = {})
  req = build_request(:create_connection, params)
  req.send_request(options)
end

#create_observability_configuration(params = {}) ⇒ Types::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.

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.

Examples:

Request syntax with placeholder values


resp = client.create_observability_configuration({
  observability_configuration_name: "ObservabilityConfigurationName", # required
  trace_configuration: {
    vendor: "AWSXRAY", # required, accepts AWSXRAY
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.observability_configuration.observability_configuration_arn #=> String
resp.observability_configuration.observability_configuration_name #=> String
resp.observability_configuration.trace_configuration.vendor #=> String, one of "AWSXRAY"
resp.observability_configuration.observability_configuration_revision #=> Integer
resp.observability_configuration.latest #=> Boolean
resp.observability_configuration.status #=> String, one of "ACTIVE", "INACTIVE"
resp.observability_configuration.created_at #=> Time
resp.observability_configuration.deleted_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :observability_configuration_name (required, String) —

    A name for the observability configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number ‘1` of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

    <note markdown=“1”> The name ‘DefaultConfiguration` is reserved. You can’t use it to create a new observability configuration, and you can’t create a revision of it.

    When you want to use your own observability configuration for your App

    Runner service, *create a configuration with a different name*, and then provide it when you create or update your service.

    </note>
  • :trace_configuration (Types::TraceConfiguration) —

    The configuration of the tracing feature within this observability configuration. If you don’t specify it, App Runner doesn’t enable tracing.

  • :tags (Array<Types::Tag>) —

    A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.

Returns:

See Also:



783
784
785
786
 
# File 'lib/aws-sdk-apprunner/client.rb', line 783

def create_observability_configuration(params = {}, options = {})
  req = build_request(:create_observability_configuration, params)
  req.send_request(options)
end

#create_service(params = {}) ⇒ Types::CreateServiceResponse

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.

[1]: docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html

Examples:

Request syntax with placeholder values


resp = client.create_service({
  service_name: "ServiceName", # required
  source_configuration: { # required
    code_repository: {
      repository_url: "String", # required
      source_code_version: { # required
        type: "BRANCH", # required, accepts BRANCH
        value: "String", # required
      },
      code_configuration: {
        configuration_source: "REPOSITORY", # required, accepts REPOSITORY, API
        code_configuration_values: {
          runtime: "PYTHON_3", # required, accepts PYTHON_3, NODEJS_12, NODEJS_14, CORRETTO_8, CORRETTO_11, NODEJS_16, GO_1, DOTNET_6, PHP_81, RUBY_31, PYTHON_311, NODEJS_18
          build_command: "BuildCommand",
          start_command: "StartCommand",
          port: "String",
          runtime_environment_variables: {
            "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
          },
          runtime_environment_secrets: {
            "RuntimeEnvironmentSecretsName" => "RuntimeEnvironmentSecretsValue",
          },
        },
      },
      source_directory: "SourceDirectory",
    },
    image_repository: {
      image_identifier: "ImageIdentifier", # required
      image_configuration: {
        runtime_environment_variables: {
          "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
        },
        start_command: "StartCommand",
        port: "String",
        runtime_environment_secrets: {
          "RuntimeEnvironmentSecretsName" => "RuntimeEnvironmentSecretsValue",
        },
      },
      image_repository_type: "ECR", # required, accepts ECR, ECR_PUBLIC
    },
    auto_deployments_enabled: false,
    authentication_configuration: {
      connection_arn: "AppRunnerResourceArn",
      access_role_arn: "RoleArn",
    },
  },
  instance_configuration: {
    cpu: "Cpu",
    memory: "Memory",
    instance_role_arn: "RoleArn",
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  encryption_configuration: {
    kms_key: "KmsKeyArn", # required
  },
  health_check_configuration: {
    protocol: "TCP", # accepts TCP, HTTP
    path: "HealthCheckPath",
    interval: 1,
    timeout: 1,
    healthy_threshold: 1,
    unhealthy_threshold: 1,
  },
  auto_scaling_configuration_arn: "AppRunnerResourceArn",
  network_configuration: {
    egress_configuration: {
      egress_type: "DEFAULT", # accepts DEFAULT, VPC
      vpc_connector_arn: "AppRunnerResourceArn",
    },
    ingress_configuration: {
      is_publicly_accessible: false,
    },
    ip_address_type: "IPV4", # accepts IPV4, DUAL_STACK
  },
  observability_configuration: {
    observability_enabled: false, # required
    observability_configuration_arn: "AppRunnerResourceArn",
  },
})

Response structure


resp.service.service_name #=> String
resp.service.service_id #=> String
resp.service.service_arn #=> String
resp.service.service_url #=> String
resp.service.created_at #=> Time
resp.service.updated_at #=> Time
resp.service.deleted_at #=> Time
resp.service.status #=> String, one of "CREATE_FAILED", "RUNNING", "DELETED", "DELETE_FAILED", "PAUSED", "OPERATION_IN_PROGRESS"
resp.service.source_configuration.code_repository.repository_url #=> String
resp.service.source_configuration.code_repository.source_code_version.type #=> String, one of "BRANCH"
resp.service.source_configuration.code_repository.source_code_version.value #=> String
resp.service.source_configuration.code_repository.code_configuration.configuration_source #=> String, one of "REPOSITORY", "API"
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime #=> String, one of "PYTHON_3", "NODEJS_12", "NODEJS_14", "CORRETTO_8", "CORRETTO_11", "NODEJS_16", "GO_1", "DOTNET_6", "PHP_81", "RUBY_31", "PYTHON_311", "NODEJS_18"
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.build_command #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.start_command #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.port #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_variables #=> Hash
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_variables["RuntimeEnvironmentVariablesKey"] #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_secrets #=> Hash
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_secrets["RuntimeEnvironmentSecretsName"] #=> String
resp.service.source_configuration.code_repository.source_directory #=> String
resp.service.source_configuration.image_repository.image_identifier #=> String
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_variables #=> Hash
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_variables["RuntimeEnvironmentVariablesKey"] #=> String
resp.service.source_configuration.image_repository.image_configuration.start_command #=> String
resp.service.source_configuration.image_repository.image_configuration.port #=> String
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_secrets #=> Hash
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_secrets["RuntimeEnvironmentSecretsName"] #=> String
resp.service.source_configuration.image_repository.image_repository_type #=> String, one of "ECR", "ECR_PUBLIC"
resp.service.source_configuration.auto_deployments_enabled #=> Boolean
resp.service.source_configuration.authentication_configuration.connection_arn #=> String
resp.service.source_configuration.authentication_configuration.access_role_arn #=> String
resp.service.instance_configuration.cpu #=> String
resp.service.instance_configuration.memory #=> String
resp.service.instance_configuration.instance_role_arn #=> String
resp.service.encryption_configuration.kms_key #=> String
resp.service.health_check_configuration.protocol #=> String, one of "TCP", "HTTP"
resp.service.health_check_configuration.path #=> String
resp.service.health_check_configuration.interval #=> Integer
resp.service.health_check_configuration.timeout #=> Integer
resp.service.health_check_configuration.healthy_threshold #=> Integer
resp.service.health_check_configuration.unhealthy_threshold #=> Integer
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_arn #=> String
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_name #=> String
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_revision #=> Integer
resp.service.auto_scaling_configuration_summary.status #=> String, one of "ACTIVE", "INACTIVE"
resp.service.auto_scaling_configuration_summary.created_at #=> Time
resp.service.auto_scaling_configuration_summary.has_associated_service #=> Boolean
resp.service.auto_scaling_configuration_summary.is_default #=> Boolean
resp.service.network_configuration.egress_configuration.egress_type #=> String, one of "DEFAULT", "VPC"
resp.service.network_configuration.egress_configuration.vpc_connector_arn #=> String
resp.service.network_configuration.ingress_configuration.is_publicly_accessible #=> Boolean
resp.service.network_configuration.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
resp.service.observability_configuration.observability_enabled #=> Boolean
resp.service.observability_configuration.observability_configuration_arn #=> String
resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_name (required, String) —

    A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.

  • :source_configuration (required, Types::SourceConfiguration) —

    The source to deploy to the App Runner service. It can be a code or an image repository.

  • :instance_configuration (Types::InstanceConfiguration) —

    The runtime configuration of instances (scaling units) of your service.

  • :tags (Array<Types::Tag>) —

    An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.

  • :encryption_configuration (Types::EncryptionConfiguration) —

    An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses an Amazon Web Services managed key.

  • :health_check_configuration (Types::HealthCheckConfiguration) —

    The settings for the health check that App Runner performs to monitor the health of the App Runner service.

  • :auto_scaling_configuration_arn (String) —

    The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration.

    Specify an ARN with a name and a revision number to associate that revision. For example: ‘arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3`

    Specify just the name to associate the latest revision. For example: ‘arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability`

  • :network_configuration (Types::NetworkConfiguration) —

    Configuration settings related to network traffic of the web application that the App Runner service runs.

  • :observability_configuration (Types::ServiceObservabilityConfiguration) —

    The observability configuration of your service.

Returns:

See Also:



1000
1001
1002
1003
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1000

def create_service(params = {}, options = {})
  req = build_request(:create_service, params)
  req.send_request(options)
end

#create_vpc_connector(params = {}) ⇒ Types::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).

Examples:

Request syntax with placeholder values


resp = client.create_vpc_connector({
  vpc_connector_name: "VpcConnectorName", # required
  subnets: ["String"], # required
  security_groups: ["String"],
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.vpc_connector.vpc_connector_name #=> String
resp.vpc_connector.vpc_connector_arn #=> String
resp.vpc_connector.vpc_connector_revision #=> Integer
resp.vpc_connector.subnets #=> Array
resp.vpc_connector.subnets[0] #=> String
resp.vpc_connector.security_groups #=> Array
resp.vpc_connector.security_groups[0] #=> String
resp.vpc_connector.status #=> String, one of "ACTIVE", "INACTIVE"
resp.vpc_connector.created_at #=> Time
resp.vpc_connector.deleted_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_connector_name (required, String) —

    A name for the VPC connector.

  • :subnets (required, Array<String>) —

    A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

    <note markdown=“1”> App Runner currently only provides support for IPv4.

    </note>
  • :security_groups (Array<String>) —

    A list of IDs of security groups that App Runner should use for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

  • :tags (Array<Types::Tag>) —

    A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.

Returns:

See Also:



1067
1068
1069
1070
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1067

def create_vpc_connector(params = {}, options = {})
  req = build_request(:create_vpc_connector, params)
  req.send_request(options)
end

#create_vpc_ingress_connection(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values


resp = client.create_vpc_ingress_connection({
  service_arn: "AppRunnerResourceArn", # required
  vpc_ingress_connection_name: "VpcIngressConnectionName", # required
  ingress_vpc_configuration: { # required
    vpc_id: "String",
    vpc_endpoint_id: "String",
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.vpc_ingress_connection.vpc_ingress_connection_arn #=> String
resp.vpc_ingress_connection.vpc_ingress_connection_name #=> String
resp.vpc_ingress_connection.service_arn #=> String
resp.vpc_ingress_connection.status #=> String, one of "AVAILABLE", "PENDING_CREATION", "PENDING_UPDATE", "PENDING_DELETION", "FAILED_CREATION", "FAILED_UPDATE", "FAILED_DELETION", "DELETED"
resp.vpc_ingress_connection. #=> String
resp.vpc_ingress_connection.domain_name #=> String
resp.vpc_ingress_connection.ingress_vpc_configuration.vpc_id #=> String
resp.vpc_ingress_connection.ingress_vpc_configuration.vpc_endpoint_id #=> String
resp.vpc_ingress_connection.created_at #=> Time
resp.vpc_ingress_connection.deleted_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_arn (required, String) —

    The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.

  • :vpc_ingress_connection_name (required, String) —

    A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your Amazon Web Services account in the Amazon Web Services Region.

  • :ingress_vpc_configuration (required, Types::IngressVpcConfiguration) —

    Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.

  • :tags (Array<Types::Tag>) —

    An optional list of metadata items that you can associate with the VPC Ingress Connection resource. A tag is a key-value pair.

Returns:

See Also:



1132
1133
1134
1135
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1132

def create_vpc_ingress_connection(params = {}, options = {})
  req = build_request(:create_vpc_ingress_connection, params)
  req.send_request(options)
end

#delete_auto_scaling_configuration(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values


resp = client.delete_auto_scaling_configuration({
  auto_scaling_configuration_arn: "AppRunnerResourceArn", # required
  delete_all_revisions: false,
})

Response structure


resp.auto_scaling_configuration.auto_scaling_configuration_arn #=> String
resp.auto_scaling_configuration.auto_scaling_configuration_name #=> String
resp.auto_scaling_configuration.auto_scaling_configuration_revision #=> Integer
resp.auto_scaling_configuration.latest #=> Boolean
resp.auto_scaling_configuration.status #=> String, one of "ACTIVE", "INACTIVE"
resp.auto_scaling_configuration.max_concurrency #=> Integer
resp.auto_scaling_configuration.min_size #=> Integer
resp.auto_scaling_configuration.max_size #=> Integer
resp.auto_scaling_configuration.created_at #=> Time
resp.auto_scaling_configuration.deleted_at #=> Time
resp.auto_scaling_configuration.has_associated_service #=> Boolean
resp.auto_scaling_configuration.is_default #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_configuration_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to delete.

    The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either ‘…/name ` or `…/name/revision `. If a revision isn’t specified, the latest active revision is deleted.

  • :delete_all_revisions (Boolean) —

    Set to ‘true` to delete all of the revisions associated with the `AutoScalingConfigurationArn` parameter value.

    When ‘DeleteAllRevisions` is set to `true`, the only valid value for the Amazon Resource Name (ARN) is a partial ARN ending with: `…/name`.

Returns:

See Also:



1189
1190
1191
1192
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1189

def delete_auto_scaling_configuration(params = {}, options = {})
  req = build_request(:delete_auto_scaling_configuration, params)
  req.send_request(options)
end

#delete_connection(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values


resp = client.delete_connection({
  connection_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.connection.connection_name #=> String
resp.connection.connection_arn #=> String
resp.connection.provider_type #=> String, one of "GITHUB", "BITBUCKET"
resp.connection.status #=> String, one of "PENDING_HANDSHAKE", "AVAILABLE", "ERROR", "DELETED"
resp.connection.created_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :connection_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.

Returns:

See Also:



1224
1225
1226
1227
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1224

def delete_connection(params = {}, options = {})
  req = build_request(:delete_connection, params)
  req.send_request(options)
end

#delete_observability_configuration(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values


resp = client.delete_observability_configuration({
  observability_configuration_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.observability_configuration.observability_configuration_arn #=> String
resp.observability_configuration.observability_configuration_name #=> String
resp.observability_configuration.trace_configuration.vendor #=> String, one of "AWSXRAY"
resp.observability_configuration.observability_configuration_revision #=> Integer
resp.observability_configuration.latest #=> Boolean
resp.observability_configuration.status #=> String, one of "ACTIVE", "INACTIVE"
resp.observability_configuration.created_at #=> Time
resp.observability_configuration.deleted_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :observability_configuration_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner observability configuration that you want to delete.

    The ARN can be a full observability configuration ARN, or a partial ARN ending with either ‘…/name ` or `…/name/revision `. If a revision isn’t specified, the latest active revision is deleted.

Returns:

See Also:



1267
1268
1269
1270
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1267

def delete_observability_configuration(params = {}, options = {})
  req = build_request(:delete_observability_configuration, params)
  req.send_request(options)
end

#delete_service(params = {}) ⇒ Types::DeleteServiceResponse

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.

<note markdown=“1”> Make sure that you don’t have any active VPCIngressConnections associated with the service you want to delete.

</note>

Examples:

Request syntax with placeholder values


resp = client.delete_service({
  service_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.service.service_name #=> String
resp.service.service_id #=> String
resp.service.service_arn #=> String
resp.service.service_url #=> String
resp.service.created_at #=> Time
resp.service.updated_at #=> Time
resp.service.deleted_at #=> Time
resp.service.status #=> String, one of "CREATE_FAILED", "RUNNING", "DELETED", "DELETE_FAILED", "PAUSED", "OPERATION_IN_PROGRESS"
resp.service.source_configuration.code_repository.repository_url #=> String
resp.service.source_configuration.code_repository.source_code_version.type #=> String, one of "BRANCH"
resp.service.source_configuration.code_repository.source_code_version.value #=> String
resp.service.source_configuration.code_repository.code_configuration.configuration_source #=> String, one of "REPOSITORY", "API"
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime #=> String, one of "PYTHON_3", "NODEJS_12", "NODEJS_14", "CORRETTO_8", "CORRETTO_11", "NODEJS_16", "GO_1", "DOTNET_6", "PHP_81", "RUBY_31", "PYTHON_311", "NODEJS_18"
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.build_command #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.start_command #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.port #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_variables #=> Hash
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_variables["RuntimeEnvironmentVariablesKey"] #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_secrets #=> Hash
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_secrets["RuntimeEnvironmentSecretsName"] #=> String
resp.service.source_configuration.code_repository.source_directory #=> String
resp.service.source_configuration.image_repository.image_identifier #=> String
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_variables #=> Hash
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_variables["RuntimeEnvironmentVariablesKey"] #=> String
resp.service.source_configuration.image_repository.image_configuration.start_command #=> String
resp.service.source_configuration.image_repository.image_configuration.port #=> String
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_secrets #=> Hash
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_secrets["RuntimeEnvironmentSecretsName"] #=> String
resp.service.source_configuration.image_repository.image_repository_type #=> String, one of "ECR", "ECR_PUBLIC"
resp.service.source_configuration.auto_deployments_enabled #=> Boolean
resp.service.source_configuration.authentication_configuration.connection_arn #=> String
resp.service.source_configuration.authentication_configuration.access_role_arn #=> String
resp.service.instance_configuration.cpu #=> String
resp.service.instance_configuration.memory #=> String
resp.service.instance_configuration.instance_role_arn #=> String
resp.service.encryption_configuration.kms_key #=> String
resp.service.health_check_configuration.protocol #=> String, one of "TCP", "HTTP"
resp.service.health_check_configuration.path #=> String
resp.service.health_check_configuration.interval #=> Integer
resp.service.health_check_configuration.timeout #=> Integer
resp.service.health_check_configuration.healthy_threshold #=> Integer
resp.service.health_check_configuration.unhealthy_threshold #=> Integer
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_arn #=> String
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_name #=> String
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_revision #=> Integer
resp.service.auto_scaling_configuration_summary.status #=> String, one of "ACTIVE", "INACTIVE"
resp.service.auto_scaling_configuration_summary.created_at #=> Time
resp.service.auto_scaling_configuration_summary.has_associated_service #=> Boolean
resp.service.auto_scaling_configuration_summary.is_default #=> Boolean
resp.service.network_configuration.egress_configuration.egress_type #=> String, one of "DEFAULT", "VPC"
resp.service.network_configuration.egress_configuration.vpc_connector_arn #=> String
resp.service.network_configuration.ingress_configuration.is_publicly_accessible #=> Boolean
resp.service.network_configuration.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
resp.service.observability_configuration.observability_enabled #=> Boolean
resp.service.observability_configuration.observability_configuration_arn #=> String
resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner service that you want to delete.

Returns:

See Also:



1361
1362
1363
1364
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1361

def delete_service(params = {}, options = {})
  req = build_request(:delete_service, params)
  req.send_request(options)
end

#delete_vpc_connector(params = {}) ⇒ Types::DeleteVpcConnectorResponse

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

Examples:

Request syntax with placeholder values


resp = client.delete_vpc_connector({
  vpc_connector_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.vpc_connector.vpc_connector_name #=> String
resp.vpc_connector.vpc_connector_arn #=> String
resp.vpc_connector.vpc_connector_revision #=> Integer
resp.vpc_connector.subnets #=> Array
resp.vpc_connector.subnets[0] #=> String
resp.vpc_connector.security_groups #=> Array
resp.vpc_connector.security_groups[0] #=> String
resp.vpc_connector.status #=> String, one of "ACTIVE", "INACTIVE"
resp.vpc_connector.created_at #=> Time
resp.vpc_connector.deleted_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_connector_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to delete.

    The ARN must be a full VPC connector ARN.

Returns:

See Also:



1402
1403
1404
1405
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1402

def delete_vpc_connector(params = {}, options = {})
  req = build_request(:delete_vpc_connector, params)
  req.send_request(options)
end

#delete_vpc_ingress_connection(params = {}) ⇒ Types::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:

  • ‘AVAILABLE`

  • ‘FAILED_CREATION`

  • ‘FAILED_UPDATE`

  • ‘FAILED_DELETION`

Examples:

Request syntax with placeholder values


resp = client.delete_vpc_ingress_connection({
  vpc_ingress_connection_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.vpc_ingress_connection.vpc_ingress_connection_arn #=> String
resp.vpc_ingress_connection.vpc_ingress_connection_name #=> String
resp.vpc_ingress_connection.service_arn #=> String
resp.vpc_ingress_connection.status #=> String, one of "AVAILABLE", "PENDING_CREATION", "PENDING_UPDATE", "PENDING_DELETION", "FAILED_CREATION", "FAILED_UPDATE", "FAILED_DELETION", "DELETED"
resp.vpc_ingress_connection. #=> String
resp.vpc_ingress_connection.domain_name #=> String
resp.vpc_ingress_connection.ingress_vpc_configuration.vpc_id #=> String
resp.vpc_ingress_connection.ingress_vpc_configuration.vpc_endpoint_id #=> String
resp.vpc_ingress_connection.created_at #=> Time
resp.vpc_ingress_connection.deleted_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_ingress_connection_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want to delete.

Returns:

See Also:



1450
1451
1452
1453
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1450

def delete_vpc_ingress_connection(params = {}, options = {})
  req = build_request(:delete_vpc_ingress_connection, params)
  req.send_request(options)
end

#describe_auto_scaling_configuration(params = {}) ⇒ Types::DescribeAutoScalingConfigurationResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_auto_scaling_configuration({
  auto_scaling_configuration_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.auto_scaling_configuration.auto_scaling_configuration_arn #=> String
resp.auto_scaling_configuration.auto_scaling_configuration_name #=> String
resp.auto_scaling_configuration.auto_scaling_configuration_revision #=> Integer
resp.auto_scaling_configuration.latest #=> Boolean
resp.auto_scaling_configuration.status #=> String, one of "ACTIVE", "INACTIVE"
resp.auto_scaling_configuration.max_concurrency #=> Integer
resp.auto_scaling_configuration.min_size #=> Integer
resp.auto_scaling_configuration.max_size #=> Integer
resp.auto_scaling_configuration.created_at #=> Time
resp.auto_scaling_configuration.deleted_at #=> Time
resp.auto_scaling_configuration.has_associated_service #=> Boolean
resp.auto_scaling_configuration.is_default #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_configuration_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want a description for.

    The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either ‘…/name ` or `…/name/revision `. If a revision isn’t specified, the latest active revision is described.

Returns:

See Also:



1495
1496
1497
1498
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1495

def describe_auto_scaling_configuration(params = {}, options = {})
  req = build_request(:describe_auto_scaling_configuration, params)
  req.send_request(options)
end

#describe_custom_domains(params = {}) ⇒ Types::DescribeCustomDomainsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_custom_domains({
  service_arn: "AppRunnerResourceArn", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.dns_target #=> String
resp.service_arn #=> String
resp.custom_domains #=> Array
resp.custom_domains[0].domain_name #=> String
resp.custom_domains[0].enable_www_subdomain #=> Boolean
resp.custom_domains[0].certificate_validation_records #=> Array
resp.custom_domains[0].certificate_validation_records[0].name #=> String
resp.custom_domains[0].certificate_validation_records[0].type #=> String
resp.custom_domains[0].certificate_validation_records[0].value #=> String
resp.custom_domains[0].certificate_validation_records[0].status #=> String, one of "PENDING_VALIDATION", "SUCCESS", "FAILED"
resp.custom_domains[0].status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETE_FAILED", "PENDING_CERTIFICATE_DNS_VALIDATION", "BINDING_CERTIFICATE"
resp.vpc_dns_targets #=> Array
resp.vpc_dns_targets[0].vpc_ingress_connection_arn #=> String
resp.vpc_dns_targets[0].vpc_id #=> String
resp.vpc_dns_targets[0].domain_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.

  • :next_token (String) —

    A token from a previous result page. It’s used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

    If you don’t specify ‘NextToken`, the request retrieves the first result page.

  • :max_results (Integer) —

    The maximum number of results that each response (result page) can include. It’s used for a paginated request.

    If you don’t specify ‘MaxResults`, the request retrieves all available results in a single response.

Returns:

See Also:



1564
1565
1566
1567
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1564

def describe_custom_domains(params = {}, options = {})
  req = build_request(:describe_custom_domains, params)
  req.send_request(options)
end

#describe_observability_configuration(params = {}) ⇒ Types::DescribeObservabilityConfigurationResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_observability_configuration({
  observability_configuration_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.observability_configuration.observability_configuration_arn #=> String
resp.observability_configuration.observability_configuration_name #=> String
resp.observability_configuration.trace_configuration.vendor #=> String, one of "AWSXRAY"
resp.observability_configuration.observability_configuration_revision #=> Integer
resp.observability_configuration.latest #=> Boolean
resp.observability_configuration.status #=> String, one of "ACTIVE", "INACTIVE"
resp.observability_configuration.created_at #=> Time
resp.observability_configuration.deleted_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :observability_configuration_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner observability configuration that you want a description for.

    The ARN can be a full observability configuration ARN, or a partial ARN ending with either ‘…/name ` or `…/name/revision `. If a revision isn’t specified, the latest active revision is described.

Returns:

See Also:



1605
1606
1607
1608
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1605

def describe_observability_configuration(params = {}, options = {})
  req = build_request(:describe_observability_configuration, params)
  req.send_request(options)
end

#describe_service(params = {}) ⇒ Types::DescribeServiceResponse

Return a full description of an App Runner service.

Examples:

Request syntax with placeholder values


resp = client.describe_service({
  service_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.service.service_name #=> String
resp.service.service_id #=> String
resp.service.service_arn #=> String
resp.service.service_url #=> String
resp.service.created_at #=> Time
resp.service.updated_at #=> Time
resp.service.deleted_at #=> Time
resp.service.status #=> String, one of "CREATE_FAILED", "RUNNING", "DELETED", "DELETE_FAILED", "PAUSED", "OPERATION_IN_PROGRESS"
resp.service.source_configuration.code_repository.repository_url #=> String
resp.service.source_configuration.code_repository.source_code_version.type #=> String, one of "BRANCH"
resp.service.source_configuration.code_repository.source_code_version.value #=> String
resp.service.source_configuration.code_repository.code_configuration.configuration_source #=> String, one of "REPOSITORY", "API"
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime #=> String, one of "PYTHON_3", "NODEJS_12", "NODEJS_14", "CORRETTO_8", "CORRETTO_11", "NODEJS_16", "GO_1", "DOTNET_6", "PHP_81", "RUBY_31", "PYTHON_311", "NODEJS_18"
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.build_command #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.start_command #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.port #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_variables #=> Hash
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_variables["RuntimeEnvironmentVariablesKey"] #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_secrets #=> Hash
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_secrets["RuntimeEnvironmentSecretsName"] #=> String
resp.service.source_configuration.code_repository.source_directory #=> String
resp.service.source_configuration.image_repository.image_identifier #=> String
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_variables #=> Hash
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_variables["RuntimeEnvironmentVariablesKey"] #=> String
resp.service.source_configuration.image_repository.image_configuration.start_command #=> String
resp.service.source_configuration.image_repository.image_configuration.port #=> String
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_secrets #=> Hash
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_secrets["RuntimeEnvironmentSecretsName"] #=> String
resp.service.source_configuration.image_repository.image_repository_type #=> String, one of "ECR", "ECR_PUBLIC"
resp.service.source_configuration.auto_deployments_enabled #=> Boolean
resp.service.source_configuration.authentication_configuration.connection_arn #=> String
resp.service.source_configuration.authentication_configuration.access_role_arn #=> String
resp.service.instance_configuration.cpu #=> String
resp.service.instance_configuration.memory #=> String
resp.service.instance_configuration.instance_role_arn #=> String
resp.service.encryption_configuration.kms_key #=> String
resp.service.health_check_configuration.protocol #=> String, one of "TCP", "HTTP"
resp.service.health_check_configuration.path #=> String
resp.service.health_check_configuration.interval #=> Integer
resp.service.health_check_configuration.timeout #=> Integer
resp.service.health_check_configuration.healthy_threshold #=> Integer
resp.service.health_check_configuration.unhealthy_threshold #=> Integer
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_arn #=> String
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_name #=> String
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_revision #=> Integer
resp.service.auto_scaling_configuration_summary.status #=> String, one of "ACTIVE", "INACTIVE"
resp.service.auto_scaling_configuration_summary.created_at #=> Time
resp.service.auto_scaling_configuration_summary.has_associated_service #=> Boolean
resp.service.auto_scaling_configuration_summary.is_default #=> Boolean
resp.service.network_configuration.egress_configuration.egress_type #=> String, one of "DEFAULT", "VPC"
resp.service.network_configuration.egress_configuration.vpc_connector_arn #=> String
resp.service.network_configuration.ingress_configuration.is_publicly_accessible #=> Boolean
resp.service.network_configuration.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
resp.service.observability_configuration.observability_enabled #=> Boolean
resp.service.observability_configuration.observability_configuration_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner service that you want a description for.

Returns:

See Also:



1688
1689
1690
1691
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1688

def describe_service(params = {}, options = {})
  req = build_request(:describe_service, params)
  req.send_request(options)
end

#describe_vpc_connector(params = {}) ⇒ Types::DescribeVpcConnectorResponse

Return a description of an App Runner VPC connector resource.

Examples:

Request syntax with placeholder values


resp = client.describe_vpc_connector({
  vpc_connector_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.vpc_connector.vpc_connector_name #=> String
resp.vpc_connector.vpc_connector_arn #=> String
resp.vpc_connector.vpc_connector_revision #=> Integer
resp.vpc_connector.subnets #=> Array
resp.vpc_connector.subnets[0] #=> String
resp.vpc_connector.security_groups #=> Array
resp.vpc_connector.security_groups[0] #=> String
resp.vpc_connector.status #=> String, one of "ACTIVE", "INACTIVE"
resp.vpc_connector.created_at #=> Time
resp.vpc_connector.deleted_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_connector_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner VPC connector that you want a description for.

    The ARN must be a full VPC connector ARN.

Returns:

See Also:



1728
1729
1730
1731
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1728

def describe_vpc_connector(params = {}, options = {})
  req = build_request(:describe_vpc_connector, params)
  req.send_request(options)
end

#describe_vpc_ingress_connection(params = {}) ⇒ Types::DescribeVpcIngressConnectionResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_vpc_ingress_connection({
  vpc_ingress_connection_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.vpc_ingress_connection.vpc_ingress_connection_arn #=> String
resp.vpc_ingress_connection.vpc_ingress_connection_name #=> String
resp.vpc_ingress_connection.service_arn #=> String
resp.vpc_ingress_connection.status #=> String, one of "AVAILABLE", "PENDING_CREATION", "PENDING_UPDATE", "PENDING_DELETION", "FAILED_CREATION", "FAILED_UPDATE", "FAILED_DELETION", "DELETED"
resp.vpc_ingress_connection. #=> String
resp.vpc_ingress_connection.domain_name #=> String
resp.vpc_ingress_connection.ingress_vpc_configuration.vpc_id #=> String
resp.vpc_ingress_connection.ingress_vpc_configuration.vpc_endpoint_id #=> String
resp.vpc_ingress_connection.created_at #=> Time
resp.vpc_ingress_connection.deleted_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_ingress_connection_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want a description for.

Returns:

See Also:



1767
1768
1769
1770
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1767

def describe_vpc_ingress_connection(params = {}, options = {})
  req = build_request(:describe_vpc_ingress_connection, params)
  req.send_request(options)
end

#disassociate_custom_domain(params = {}) ⇒ Types::DisassociateCustomDomainResponse

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.

[1]: docs.aws.amazon.com/acm/latest/userguide

Examples:

Request syntax with placeholder values


resp = client.disassociate_custom_domain({
  service_arn: "AppRunnerResourceArn", # required
  domain_name: "DomainName", # required
})

Response structure


resp.dns_target #=> String
resp.service_arn #=> String
resp.custom_domain.domain_name #=> String
resp.custom_domain.enable_www_subdomain #=> Boolean
resp.custom_domain.certificate_validation_records #=> Array
resp.custom_domain.certificate_validation_records[0].name #=> String
resp.custom_domain.certificate_validation_records[0].type #=> String
resp.custom_domain.certificate_validation_records[0].value #=> String
resp.custom_domain.certificate_validation_records[0].status #=> String, one of "PENDING_VALIDATION", "SUCCESS", "FAILED"
resp.custom_domain.status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETE_FAILED", "PENDING_CERTIFICATE_DNS_VALIDATION", "BINDING_CERTIFICATE"
resp.vpc_dns_targets #=> Array
resp.vpc_dns_targets[0].vpc_ingress_connection_arn #=> String
resp.vpc_dns_targets[0].vpc_id #=> String
resp.vpc_dns_targets[0].domain_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from.

  • :domain_name (required, String) —

    The domain name that you want to disassociate from the App Runner service.

Returns:

See Also:



1827
1828
1829
1830
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1827

def disassociate_custom_domain(params = {}, options = {})
  req = build_request(:disassociate_custom_domain, params)
  req.send_request(options)
end

#list_auto_scaling_configurations(params = {}) ⇒ Types::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.

To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by ‘ListAutoScalingConfigurations`.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_auto_scaling_configurations({
  auto_scaling_configuration_name: "AutoScalingConfigurationName",
  latest_only: false,
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.auto_scaling_configuration_summary_list #=> Array
resp.auto_scaling_configuration_summary_list[0].auto_scaling_configuration_arn #=> String
resp.auto_scaling_configuration_summary_list[0].auto_scaling_configuration_name #=> String
resp.auto_scaling_configuration_summary_list[0].auto_scaling_configuration_revision #=> Integer
resp.auto_scaling_configuration_summary_list[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.auto_scaling_configuration_summary_list[0].created_at #=> Time
resp.auto_scaling_configuration_summary_list[0].has_associated_service #=> Boolean
resp.auto_scaling_configuration_summary_list[0].is_default #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_configuration_name (String) —

    The name of the App Runner auto scaling configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner returns revisions of all active configurations.

  • :latest_only (Boolean) —

    Set to ‘true` to list only the latest revision for each requested configuration name.

    Set to ‘false` to list all revisions for each requested configuration name.

    Default: ‘true`

  • :max_results (Integer) —

    The maximum number of results to include in each response (result page). It’s used for a paginated request.

    If you don’t specify ‘MaxResults`, the request retrieves all available results in a single response.

  • :next_token (String) —

    A token from a previous result page. It’s used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

    If you don’t specify ‘NextToken`, the request retrieves the first result page.

Returns:

See Also:



1905
1906
1907
1908
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1905

def list_auto_scaling_configurations(params = {}, options = {})
  req = build_request(:list_auto_scaling_configurations, params)
  req.send_request(options)
end

#list_connections(params = {}) ⇒ Types::ListConnectionsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_connections({
  connection_name: "ConnectionName",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.connection_summary_list #=> Array
resp.connection_summary_list[0].connection_name #=> String
resp.connection_summary_list[0].connection_arn #=> String
resp.connection_summary_list[0].provider_type #=> String, one of "GITHUB", "BITBUCKET"
resp.connection_summary_list[0].status #=> String, one of "PENDING_HANDSHAKE", "AVAILABLE", "ERROR", "DELETED"
resp.connection_summary_list[0].created_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :connection_name (String) —

    If specified, only this connection is returned. If not specified, the result isn’t filtered by name.

  • :max_results (Integer) —

    The maximum number of results to include in each response (result page). Used for a paginated request.

    If you don’t specify ‘MaxResults`, the request retrieves all available results in a single response.

  • :next_token (String) —

    A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.

    If you don’t specify ‘NextToken`, the request retrieves the first result page.

Returns:

See Also:



1961
1962
1963
1964
 
# File 'lib/aws-sdk-apprunner/client.rb', line 1961

def list_connections(params = {}, options = {})
  req = build_request(:list_connections, params)
  req.send_request(options)
end

#list_observability_configurations(params = {}) ⇒ Types::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.

To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by ‘ListObservabilityConfigurations`.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_observability_configurations({
  observability_configuration_name: "ObservabilityConfigurationName",
  latest_only: false,
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.observability_configuration_summary_list #=> Array
resp.observability_configuration_summary_list[0].observability_configuration_arn #=> String
resp.observability_configuration_summary_list[0].observability_configuration_name #=> String
resp.observability_configuration_summary_list[0].observability_configuration_revision #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :observability_configuration_name (String) —

    The name of the App Runner observability configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner returns revisions of all active configurations.

  • :latest_only (Boolean) —

    Set to ‘true` to list only the latest revision for each requested configuration name.

    Set to ‘false` to list all revisions for each requested configuration name.

    Default: ‘true`

  • :max_results (Integer) —

    The maximum number of results to include in each response (result page). It’s used for a paginated request.

    If you don’t specify ‘MaxResults`, the request retrieves all available results in a single response.

  • :next_token (String) —

    A token from a previous result page. It’s used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

    If you don’t specify ‘NextToken`, the request retrieves the first result page.

Returns:

See Also:



2035
2036
2037
2038
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2035

def list_observability_configurations(params = {}, options = {})
  req = build_request(:list_observability_configurations, params)
  req.send_request(options)
end

#list_operations(params = {}) ⇒ Types::ListOperationsResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_operations({
  service_arn: "AppRunnerResourceArn", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.operation_summary_list #=> Array
resp.operation_summary_list[0].id #=> String
resp.operation_summary_list[0].type #=> String, one of "START_DEPLOYMENT", "CREATE_SERVICE", "PAUSE_SERVICE", "RESUME_SERVICE", "DELETE_SERVICE", "UPDATE_SERVICE"
resp.operation_summary_list[0].status #=> String, one of "PENDING", "IN_PROGRESS", "FAILED", "SUCCEEDED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_FAILED", "ROLLBACK_SUCCEEDED"
resp.operation_summary_list[0].target_arn #=> String
resp.operation_summary_list[0].started_at #=> Time
resp.operation_summary_list[0].ended_at #=> Time
resp.operation_summary_list[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner service that you want a list of operations for.

  • :next_token (String) —

    A token from a previous result page. It’s used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.

    If you don’t specify ‘NextToken`, the request retrieves the first result page.

  • :max_results (Integer) —

    The maximum number of results to include in each response (result page). It’s used for a paginated request.

    If you don’t specify ‘MaxResults`, the request retrieves all available results in a single response.

Returns:

See Also:



2097
2098
2099
2100
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2097

def list_operations(params = {}, options = {})
  req = build_request(:list_operations, params)
  req.send_request(options)
end

#list_services(params = {}) ⇒ Types::ListServicesResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_services({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.service_summary_list #=> Array
resp.service_summary_list[0].service_name #=> String
resp.service_summary_list[0].service_id #=> String
resp.service_summary_list[0].service_arn #=> String
resp.service_summary_list[0].service_url #=> String
resp.service_summary_list[0].created_at #=> Time
resp.service_summary_list[0].updated_at #=> Time
resp.service_summary_list[0].status #=> String, one of "CREATE_FAILED", "RUNNING", "DELETED", "DELETE_FAILED", "PAUSED", "OPERATION_IN_PROGRESS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.

    If you don’t specify ‘NextToken`, the request retrieves the first result page.

  • :max_results (Integer) —

    The maximum number of results to include in each response (result page). It’s used for a paginated request.

    If you don’t specify ‘MaxResults`, the request retrieves all available results in a single response.

Returns:

See Also:



2150
2151
2152
2153
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2150

def list_services(params = {}, options = {})
  req = build_request(:list_services, params)
  req.send_request(options)
end

#list_services_for_auto_scaling_configuration(params = {}) ⇒ Types::ListServicesForAutoScalingConfigurationResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_services_for_auto_scaling_configuration({
  auto_scaling_configuration_arn: "AppRunnerResourceArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.service_arn_list #=> Array
resp.service_arn_list[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_configuration_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to list the services for.

    The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either ‘…/name ` or `…/name/revision `. If a revision isn’t specified, the latest active revision is used.

  • :max_results (Integer) —

    The maximum number of results to include in each response (result page). It’s used for a paginated request.

    If you don’t specify ‘MaxResults`, the request retrieves all available results in a single response.

  • :next_token (String) —

    A token from a previous result page. It’s used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.

    If you don’t specify ‘NextToken`, the request retrieves the first result page.

Returns:

See Also:



2207
2208
2209
2210
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2207

def list_services_for_auto_scaling_configuration(params = {}, options = {})
  req = build_request(:list_services_for_auto_scaling_configuration, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that a tag list is requested for.

    It must be the ARN of an App Runner resource.

Returns:

See Also:



2241
2242
2243
2244
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2241

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_vpc_connectors(params = {}) ⇒ Types::ListVpcConnectorsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_vpc_connectors({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.vpc_connectors #=> Array
resp.vpc_connectors[0].vpc_connector_name #=> String
resp.vpc_connectors[0].vpc_connector_arn #=> String
resp.vpc_connectors[0].vpc_connector_revision #=> Integer
resp.vpc_connectors[0].subnets #=> Array
resp.vpc_connectors[0].subnets[0] #=> String
resp.vpc_connectors[0].security_groups #=> Array
resp.vpc_connectors[0].security_groups[0] #=> String
resp.vpc_connectors[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.vpc_connectors[0].created_at #=> Time
resp.vpc_connectors[0].deleted_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to include in each response (result page). It’s used for a paginated request.

    If you don’t specify ‘MaxResults`, the request retrieves all available results in a single response.

  • :next_token (String) —

    A token from a previous result page. It’s used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

    If you don’t specify ‘NextToken`, the request retrieves the first result page.

Returns:

See Also:



2298
2299
2300
2301
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2298

def list_vpc_connectors(params = {}, options = {})
  req = build_request(:list_vpc_connectors, params)
  req.send_request(options)
end

#list_vpc_ingress_connections(params = {}) ⇒ Types::ListVpcIngressConnectionsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_vpc_ingress_connections({
  filter: {
    service_arn: "AppRunnerResourceArn",
    vpc_endpoint_id: "String",
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.vpc_ingress_connection_summary_list #=> Array
resp.vpc_ingress_connection_summary_list[0].vpc_ingress_connection_arn #=> String
resp.vpc_ingress_connection_summary_list[0].service_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::ListVpcIngressConnectionsFilter) —

    The VPC Ingress Connections to be listed based on either the Service Arn or Vpc Endpoint Id, or both.

  • :max_results (Integer) —

    The maximum number of results to include in each response (result page). It’s used for a paginated request.

    If you don’t specify ‘MaxResults`, the request retrieves all available results in a single response.

  • :next_token (String) —

    A token from a previous result page. It’s used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

    If you don’t specify ‘NextToken`, the request retrieves the first result page.

Returns:

See Also:



2355
2356
2357
2358
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2355

def list_vpc_ingress_connections(params = {}, options = {})
  req = build_request(:list_vpc_ingress_connections, params)
  req.send_request(options)
end

#pause_service(params = {}) ⇒ Types::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).

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.

Examples:

Request syntax with placeholder values


resp = client.pause_service({
  service_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.service.service_name #=> String
resp.service.service_id #=> String
resp.service.service_arn #=> String
resp.service.service_url #=> String
resp.service.created_at #=> Time
resp.service.updated_at #=> Time
resp.service.deleted_at #=> Time
resp.service.status #=> String, one of "CREATE_FAILED", "RUNNING", "DELETED", "DELETE_FAILED", "PAUSED", "OPERATION_IN_PROGRESS"
resp.service.source_configuration.code_repository.repository_url #=> String
resp.service.source_configuration.code_repository.source_code_version.type #=> String, one of "BRANCH"
resp.service.source_configuration.code_repository.source_code_version.value #=> String
resp.service.source_configuration.code_repository.code_configuration.configuration_source #=> String, one of "REPOSITORY", "API"
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime #=> String, one of "PYTHON_3", "NODEJS_12", "NODEJS_14", "CORRETTO_8", "CORRETTO_11", "NODEJS_16", "GO_1", "DOTNET_6", "PHP_81", "RUBY_31", "PYTHON_311", "NODEJS_18"
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.build_command #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.start_command #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.port #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_variables #=> Hash
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_variables["RuntimeEnvironmentVariablesKey"] #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_secrets #=> Hash
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_secrets["RuntimeEnvironmentSecretsName"] #=> String
resp.service.source_configuration.code_repository.source_directory #=> String
resp.service.source_configuration.image_repository.image_identifier #=> String
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_variables #=> Hash
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_variables["RuntimeEnvironmentVariablesKey"] #=> String
resp.service.source_configuration.image_repository.image_configuration.start_command #=> String
resp.service.source_configuration.image_repository.image_configuration.port #=> String
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_secrets #=> Hash
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_secrets["RuntimeEnvironmentSecretsName"] #=> String
resp.service.source_configuration.image_repository.image_repository_type #=> String, one of "ECR", "ECR_PUBLIC"
resp.service.source_configuration.auto_deployments_enabled #=> Boolean
resp.service.source_configuration.authentication_configuration.connection_arn #=> String
resp.service.source_configuration.authentication_configuration.access_role_arn #=> String
resp.service.instance_configuration.cpu #=> String
resp.service.instance_configuration.memory #=> String
resp.service.instance_configuration.instance_role_arn #=> String
resp.service.encryption_configuration.kms_key #=> String
resp.service.health_check_configuration.protocol #=> String, one of "TCP", "HTTP"
resp.service.health_check_configuration.path #=> String
resp.service.health_check_configuration.interval #=> Integer
resp.service.health_check_configuration.timeout #=> Integer
resp.service.health_check_configuration.healthy_threshold #=> Integer
resp.service.health_check_configuration.unhealthy_threshold #=> Integer
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_arn #=> String
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_name #=> String
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_revision #=> Integer
resp.service.auto_scaling_configuration_summary.status #=> String, one of "ACTIVE", "INACTIVE"
resp.service.auto_scaling_configuration_summary.created_at #=> Time
resp.service.auto_scaling_configuration_summary.has_associated_service #=> Boolean
resp.service.auto_scaling_configuration_summary.is_default #=> Boolean
resp.service.network_configuration.egress_configuration.egress_type #=> String, one of "DEFAULT", "VPC"
resp.service.network_configuration.egress_configuration.vpc_connector_arn #=> String
resp.service.network_configuration.ingress_configuration.is_publicly_accessible #=> Boolean
resp.service.network_configuration.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
resp.service.observability_configuration.observability_enabled #=> Boolean
resp.service.observability_configuration.observability_configuration_arn #=> String
resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner service that you want to pause.

Returns:

See Also:



2446
2447
2448
2449
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2446

def pause_service(params = {}, options = {})
  req = build_request(:pause_service, params)
  req.send_request(options)
end

#resume_service(params = {}) ⇒ Types::ResumeServiceResponse

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.

Examples:

Request syntax with placeholder values


resp = client.resume_service({
  service_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.service.service_name #=> String
resp.service.service_id #=> String
resp.service.service_arn #=> String
resp.service.service_url #=> String
resp.service.created_at #=> Time
resp.service.updated_at #=> Time
resp.service.deleted_at #=> Time
resp.service.status #=> String, one of "CREATE_FAILED", "RUNNING", "DELETED", "DELETE_FAILED", "PAUSED", "OPERATION_IN_PROGRESS"
resp.service.source_configuration.code_repository.repository_url #=> String
resp.service.source_configuration.code_repository.source_code_version.type #=> String, one of "BRANCH"
resp.service.source_configuration.code_repository.source_code_version.value #=> String
resp.service.source_configuration.code_repository.code_configuration.configuration_source #=> String, one of "REPOSITORY", "API"
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime #=> String, one of "PYTHON_3", "NODEJS_12", "NODEJS_14", "CORRETTO_8", "CORRETTO_11", "NODEJS_16", "GO_1", "DOTNET_6", "PHP_81", "RUBY_31", "PYTHON_311", "NODEJS_18"
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.build_command #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.start_command #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.port #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_variables #=> Hash
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_variables["RuntimeEnvironmentVariablesKey"] #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_secrets #=> Hash
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_secrets["RuntimeEnvironmentSecretsName"] #=> String
resp.service.source_configuration.code_repository.source_directory #=> String
resp.service.source_configuration.image_repository.image_identifier #=> String
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_variables #=> Hash
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_variables["RuntimeEnvironmentVariablesKey"] #=> String
resp.service.source_configuration.image_repository.image_configuration.start_command #=> String
resp.service.source_configuration.image_repository.image_configuration.port #=> String
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_secrets #=> Hash
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_secrets["RuntimeEnvironmentSecretsName"] #=> String
resp.service.source_configuration.image_repository.image_repository_type #=> String, one of "ECR", "ECR_PUBLIC"
resp.service.source_configuration.auto_deployments_enabled #=> Boolean
resp.service.source_configuration.authentication_configuration.connection_arn #=> String
resp.service.source_configuration.authentication_configuration.access_role_arn #=> String
resp.service.instance_configuration.cpu #=> String
resp.service.instance_configuration.memory #=> String
resp.service.instance_configuration.instance_role_arn #=> String
resp.service.encryption_configuration.kms_key #=> String
resp.service.health_check_configuration.protocol #=> String, one of "TCP", "HTTP"
resp.service.health_check_configuration.path #=> String
resp.service.health_check_configuration.interval #=> Integer
resp.service.health_check_configuration.timeout #=> Integer
resp.service.health_check_configuration.healthy_threshold #=> Integer
resp.service.health_check_configuration.unhealthy_threshold #=> Integer
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_arn #=> String
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_name #=> String
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_revision #=> Integer
resp.service.auto_scaling_configuration_summary.status #=> String, one of "ACTIVE", "INACTIVE"
resp.service.auto_scaling_configuration_summary.created_at #=> Time
resp.service.auto_scaling_configuration_summary.has_associated_service #=> Boolean
resp.service.auto_scaling_configuration_summary.is_default #=> Boolean
resp.service.network_configuration.egress_configuration.egress_type #=> String, one of "DEFAULT", "VPC"
resp.service.network_configuration.egress_configuration.vpc_connector_arn #=> String
resp.service.network_configuration.ingress_configuration.is_publicly_accessible #=> Boolean
resp.service.network_configuration.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
resp.service.observability_configuration.observability_enabled #=> Boolean
resp.service.observability_configuration.observability_configuration_arn #=> String
resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner service that you want to resume.

Returns:

See Also:



2536
2537
2538
2539
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2536

def resume_service(params = {}, options = {})
  req = build_request(:resume_service, params)
  req.send_request(options)
end

#start_deployment(params = {}) ⇒ Types::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.

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.

Examples:

Request syntax with placeholder values


resp = client.start_deployment({
  service_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner service that you want to manually deploy to.

Returns:

See Also:



2577
2578
2579
2580
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2577

def start_deployment(params = {}, options = {})
  req = build_request(:start_deployment, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AppRunnerResourceArn", # required
  tags: [ # required
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to update tags for.

    It must be the ARN of an App Runner resource.

  • :tags (required, Array<Types::Tag>) —

    A list of tag key-value pairs to add or update. If a key is new to the resource, the tag is added with the provided value. If a key is already associated with the resource, the value of the tag is updated.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2614
2615
2616
2617
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2614

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Remove tags from an App Runner resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AppRunnerResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

    It must be the ARN of an App Runner resource.

  • :tag_keys (required, Array<String>) —

    A list of tag keys that you want to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2643
2644
2645
2646
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2643

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_default_auto_scaling_configuration(params = {}) ⇒ Types::UpdateDefaultAutoScalingConfigurationResponse

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

Examples:

Request syntax with placeholder values


resp = client.update_default_auto_scaling_configuration({
  auto_scaling_configuration_arn: "AppRunnerResourceArn", # required
})

Response structure


resp.auto_scaling_configuration.auto_scaling_configuration_arn #=> String
resp.auto_scaling_configuration.auto_scaling_configuration_name #=> String
resp.auto_scaling_configuration.auto_scaling_configuration_revision #=> Integer
resp.auto_scaling_configuration.latest #=> Boolean
resp.auto_scaling_configuration.status #=> String, one of "ACTIVE", "INACTIVE"
resp.auto_scaling_configuration.max_concurrency #=> Integer
resp.auto_scaling_configuration.min_size #=> Integer
resp.auto_scaling_configuration.max_size #=> Integer
resp.auto_scaling_configuration.created_at #=> Time
resp.auto_scaling_configuration.deleted_at #=> Time
resp.auto_scaling_configuration.has_associated_service #=> Boolean
resp.auto_scaling_configuration.is_default #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_scaling_configuration_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to set as the default.

    The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either ‘…/name ` or `…/name/revision `. If a revision isn’t specified, the latest active revision is set as the default.

Returns:

See Also:



2689
2690
2691
2692
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2689

def update_default_auto_scaling_configuration(params = {}, options = {})
  req = build_request(:update_default_auto_scaling_configuration, params)
  req.send_request(options)
end

#update_service(params = {}) ⇒ Types::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.

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.

Examples:

Request syntax with placeholder values


resp = client.update_service({
  service_arn: "AppRunnerResourceArn", # required
  source_configuration: {
    code_repository: {
      repository_url: "String", # required
      source_code_version: { # required
        type: "BRANCH", # required, accepts BRANCH
        value: "String", # required
      },
      code_configuration: {
        configuration_source: "REPOSITORY", # required, accepts REPOSITORY, API
        code_configuration_values: {
          runtime: "PYTHON_3", # required, accepts PYTHON_3, NODEJS_12, NODEJS_14, CORRETTO_8, CORRETTO_11, NODEJS_16, GO_1, DOTNET_6, PHP_81, RUBY_31, PYTHON_311, NODEJS_18
          build_command: "BuildCommand",
          start_command: "StartCommand",
          port: "String",
          runtime_environment_variables: {
            "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
          },
          runtime_environment_secrets: {
            "RuntimeEnvironmentSecretsName" => "RuntimeEnvironmentSecretsValue",
          },
        },
      },
      source_directory: "SourceDirectory",
    },
    image_repository: {
      image_identifier: "ImageIdentifier", # required
      image_configuration: {
        runtime_environment_variables: {
          "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
        },
        start_command: "StartCommand",
        port: "String",
        runtime_environment_secrets: {
          "RuntimeEnvironmentSecretsName" => "RuntimeEnvironmentSecretsValue",
        },
      },
      image_repository_type: "ECR", # required, accepts ECR, ECR_PUBLIC
    },
    auto_deployments_enabled: false,
    authentication_configuration: {
      connection_arn: "AppRunnerResourceArn",
      access_role_arn: "RoleArn",
    },
  },
  instance_configuration: {
    cpu: "Cpu",
    memory: "Memory",
    instance_role_arn: "RoleArn",
  },
  auto_scaling_configuration_arn: "AppRunnerResourceArn",
  health_check_configuration: {
    protocol: "TCP", # accepts TCP, HTTP
    path: "HealthCheckPath",
    interval: 1,
    timeout: 1,
    healthy_threshold: 1,
    unhealthy_threshold: 1,
  },
  network_configuration: {
    egress_configuration: {
      egress_type: "DEFAULT", # accepts DEFAULT, VPC
      vpc_connector_arn: "AppRunnerResourceArn",
    },
    ingress_configuration: {
      is_publicly_accessible: false,
    },
    ip_address_type: "IPV4", # accepts IPV4, DUAL_STACK
  },
  observability_configuration: {
    observability_enabled: false, # required
    observability_configuration_arn: "AppRunnerResourceArn",
  },
})

Response structure


resp.service.service_name #=> String
resp.service.service_id #=> String
resp.service.service_arn #=> String
resp.service.service_url #=> String
resp.service.created_at #=> Time
resp.service.updated_at #=> Time
resp.service.deleted_at #=> Time
resp.service.status #=> String, one of "CREATE_FAILED", "RUNNING", "DELETED", "DELETE_FAILED", "PAUSED", "OPERATION_IN_PROGRESS"
resp.service.source_configuration.code_repository.repository_url #=> String
resp.service.source_configuration.code_repository.source_code_version.type #=> String, one of "BRANCH"
resp.service.source_configuration.code_repository.source_code_version.value #=> String
resp.service.source_configuration.code_repository.code_configuration.configuration_source #=> String, one of "REPOSITORY", "API"
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime #=> String, one of "PYTHON_3", "NODEJS_12", "NODEJS_14", "CORRETTO_8", "CORRETTO_11", "NODEJS_16", "GO_1", "DOTNET_6", "PHP_81", "RUBY_31", "PYTHON_311", "NODEJS_18"
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.build_command #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.start_command #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.port #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_variables #=> Hash
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_variables["RuntimeEnvironmentVariablesKey"] #=> String
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_secrets #=> Hash
resp.service.source_configuration.code_repository.code_configuration.code_configuration_values.runtime_environment_secrets["RuntimeEnvironmentSecretsName"] #=> String
resp.service.source_configuration.code_repository.source_directory #=> String
resp.service.source_configuration.image_repository.image_identifier #=> String
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_variables #=> Hash
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_variables["RuntimeEnvironmentVariablesKey"] #=> String
resp.service.source_configuration.image_repository.image_configuration.start_command #=> String
resp.service.source_configuration.image_repository.image_configuration.port #=> String
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_secrets #=> Hash
resp.service.source_configuration.image_repository.image_configuration.runtime_environment_secrets["RuntimeEnvironmentSecretsName"] #=> String
resp.service.source_configuration.image_repository.image_repository_type #=> String, one of "ECR", "ECR_PUBLIC"
resp.service.source_configuration.auto_deployments_enabled #=> Boolean
resp.service.source_configuration.authentication_configuration.connection_arn #=> String
resp.service.source_configuration.authentication_configuration.access_role_arn #=> String
resp.service.instance_configuration.cpu #=> String
resp.service.instance_configuration.memory #=> String
resp.service.instance_configuration.instance_role_arn #=> String
resp.service.encryption_configuration.kms_key #=> String
resp.service.health_check_configuration.protocol #=> String, one of "TCP", "HTTP"
resp.service.health_check_configuration.path #=> String
resp.service.health_check_configuration.interval #=> Integer
resp.service.health_check_configuration.timeout #=> Integer
resp.service.health_check_configuration.healthy_threshold #=> Integer
resp.service.health_check_configuration.unhealthy_threshold #=> Integer
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_arn #=> String
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_name #=> String
resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_revision #=> Integer
resp.service.auto_scaling_configuration_summary.status #=> String, one of "ACTIVE", "INACTIVE"
resp.service.auto_scaling_configuration_summary.created_at #=> Time
resp.service.auto_scaling_configuration_summary.has_associated_service #=> Boolean
resp.service.auto_scaling_configuration_summary.is_default #=> Boolean
resp.service.network_configuration.egress_configuration.egress_type #=> String, one of "DEFAULT", "VPC"
resp.service.network_configuration.egress_configuration.vpc_connector_arn #=> String
resp.service.network_configuration.ingress_configuration.is_publicly_accessible #=> Boolean
resp.service.network_configuration.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
resp.service.observability_configuration.observability_enabled #=> Boolean
resp.service.observability_configuration.observability_configuration_arn #=> String
resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_arn (required, String) —

    The Amazon Resource Name (ARN) of the App Runner service that you want to update.

  • :source_configuration (Types::SourceConfiguration) —

    The source configuration to apply to the App Runner service.

    You can change the configuration of the code or image repository that the service uses. However, you can’t switch from code to image or the other way around. This means that you must provide the same structure member of ‘SourceConfiguration` that you originally included when you created the service. Specifically, you can include either `CodeRepository` or `ImageRepository`. To update the source configuration, set the values to members of the structure that you include.

  • :instance_configuration (Types::InstanceConfiguration) —

    The runtime configuration to apply to instances (scaling units) of your service.

  • :auto_scaling_configuration_arn (String) —

    The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service.

  • :health_check_configuration (Types::HealthCheckConfiguration) —

    The settings for the health check that App Runner performs to monitor the health of the App Runner service.

  • :network_configuration (Types::NetworkConfiguration) —

    Configuration settings related to network traffic of the web application that the App Runner service runs.

  • :observability_configuration (Types::ServiceObservabilityConfiguration) —

    The observability configuration of your service.

Returns:

See Also:



2890
2891
2892
2893
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2890

def update_service(params = {}, options = {})
  req = build_request(:update_service, params)
  req.send_request(options)
end

#update_vpc_ingress_connection(params = {}) ⇒ Types::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:

  • AVAILABLE

  • FAILED_CREATION

  • FAILED_UPDATE

Examples:

Request syntax with placeholder values


resp = client.update_vpc_ingress_connection({
  vpc_ingress_connection_arn: "AppRunnerResourceArn", # required
  ingress_vpc_configuration: { # required
    vpc_id: "String",
    vpc_endpoint_id: "String",
  },
})

Response structure


resp.vpc_ingress_connection.vpc_ingress_connection_arn #=> String
resp.vpc_ingress_connection.vpc_ingress_connection_name #=> String
resp.vpc_ingress_connection.service_arn #=> String
resp.vpc_ingress_connection.status #=> String, one of "AVAILABLE", "PENDING_CREATION", "PENDING_UPDATE", "PENDING_DELETION", "FAILED_CREATION", "FAILED_UPDATE", "FAILED_DELETION", "DELETED"
resp.vpc_ingress_connection. #=> String
resp.vpc_ingress_connection.domain_name #=> String
resp.vpc_ingress_connection.ingress_vpc_configuration.vpc_id #=> String
resp.vpc_ingress_connection.ingress_vpc_configuration.vpc_endpoint_id #=> String
resp.vpc_ingress_connection.created_at #=> Time
resp.vpc_ingress_connection.deleted_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_ingress_connection_arn (required, String) —

    The Amazon Resource Name (Arn) for the App Runner VPC Ingress Connection resource that you want to update.

  • :ingress_vpc_configuration (required, Types::IngressVpcConfiguration) —

    Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to update the VPC Ingress Connection resource.

Returns:

See Also:



2945
2946
2947
2948
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2945

def update_vpc_ingress_connection(params = {}, options = {})
  req = build_request(:update_vpc_ingress_connection, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


2974
2975
2976
 
# File 'lib/aws-sdk-apprunner/client.rb', line 2974

def waiter_names
  []
end