Class: Aws::AppRunner::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AppRunner::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-apprunner/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_custom_domain(params = {}) ⇒ Types::AssociateCustomDomainResponse
Associate your own domain name with the App Runner subdomain URL of your App Runner service.
-
#create_auto_scaling_configuration(params = {}) ⇒ Types::CreateAutoScalingConfigurationResponse
Create an App Runner automatic scaling configuration resource.
-
#create_connection(params = {}) ⇒ Types::CreateConnectionResponse
Create an App Runner connection resource.
-
#create_observability_configuration(params = {}) ⇒ Types::CreateObservabilityConfigurationResponse
Create an App Runner observability configuration resource.
-
#create_service(params = {}) ⇒ Types::CreateServiceResponse
Create an App Runner service.
-
#create_vpc_connector(params = {}) ⇒ Types::CreateVpcConnectorResponse
Create an App Runner VPC connector resource.
-
#delete_auto_scaling_configuration(params = {}) ⇒ Types::DeleteAutoScalingConfigurationResponse
Delete an App Runner automatic scaling configuration resource.
-
#delete_connection(params = {}) ⇒ Types::DeleteConnectionResponse
Delete an App Runner connection.
-
#delete_observability_configuration(params = {}) ⇒ Types::DeleteObservabilityConfigurationResponse
Delete an App Runner observability configuration resource.
-
#delete_service(params = {}) ⇒ Types::DeleteServiceResponse
Delete an App Runner service.
-
#delete_vpc_connector(params = {}) ⇒ Types::DeleteVpcConnectorResponse
Delete an App Runner VPC connector resource.
-
#describe_auto_scaling_configuration(params = {}) ⇒ Types::DescribeAutoScalingConfigurationResponse
Return a full description of an App Runner automatic scaling configuration resource.
-
#describe_custom_domains(params = {}) ⇒ Types::DescribeCustomDomainsResponse
Return a description of custom domain names that are associated with an App Runner service.
-
#describe_observability_configuration(params = {}) ⇒ Types::DescribeObservabilityConfigurationResponse
Return a full description of an App Runner observability configuration resource.
-
#describe_service(params = {}) ⇒ Types::DescribeServiceResponse
Return a full description of an App Runner service.
-
#describe_vpc_connector(params = {}) ⇒ Types::DescribeVpcConnectorResponse
Return a description of an App Runner VPC connector resource.
-
#disassociate_custom_domain(params = {}) ⇒ Types::DisassociateCustomDomainResponse
Disassociate a custom domain name from an App Runner service.
-
#list_auto_scaling_configurations(params = {}) ⇒ Types::ListAutoScalingConfigurationsResponse
Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account.
-
#list_connections(params = {}) ⇒ Types::ListConnectionsResponse
Returns a list of App Runner connections that are associated with your Amazon Web Services account.
-
#list_observability_configurations(params = {}) ⇒ Types::ListObservabilityConfigurationsResponse
Returns a list of active App Runner observability configurations in your Amazon Web Services account.
-
#list_operations(params = {}) ⇒ Types::ListOperationsResponse
Return a list of operations that occurred on an App Runner service.
-
#list_services(params = {}) ⇒ Types::ListServicesResponse
Returns a list of running App Runner services in your Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List tags that are associated with for an App Runner resource.
-
#list_vpc_connectors(params = {}) ⇒ Types::ListVpcConnectorsResponse
Returns a list of App Runner VPC connectors in your Amazon Web Services account.
-
#pause_service(params = {}) ⇒ Types::PauseServiceResponse
Pause an active App Runner service.
-
#resume_service(params = {}) ⇒ Types::ResumeServiceResponse
Resume an active App Runner service.
-
#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.
-
#tag_resource(params = {}) ⇒ Struct
Add tags to, or update the tag values of, an App Runner resource.
-
#untag_resource(params = {}) ⇒ Struct
Remove tags from an App Runner resource.
-
#update_service(params = {}) ⇒ Types::UpdateServiceResponse
Update an App Runner service.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
358 359 360 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 358 def initialize(*args) super 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).
427 428 429 430 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 427 def associate_custom_domain(params = {}, = {}) req = build_request(:associate_custom_domain, params) req.send_request() 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.
538 539 540 541 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 538 def create_auto_scaling_configuration(params = {}, = {}) req = build_request(:create_auto_scaling_configuration, params) req.send_request() 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 repositories. GitHub requires a user interface approval process through the App Runner console before you can use the connection.
593 594 595 596 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 593 def create_connection(params = {}, = {}) req = build_request(:create_connection, params) req.send_request() 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.
677 678 679 680 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 677 def create_observability_configuration(params = {}, = {}) req = build_request(:create_observability_configuration, params) req.send_request() 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.
872 873 874 875 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 872 def create_service(params = {}, = {}) req = build_request(:create_service, params) req.send_request() 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).
939 940 941 942 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 939 def create_vpc_connector(params = {}, = {}) req = build_request(:create_vpc_connector, params) req.send_request() end |
#delete_auto_scaling_configuration(params = {}) ⇒ Types::DeleteAutoScalingConfigurationResponse
Delete an App Runner automatic scaling configuration resource. You can delete a specific revision or the latest active revision. You can't delete a configuration that's used by one or more App Runner services.
984 985 986 987 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 984 def delete_auto_scaling_configuration(params = {}, = {}) req = build_request(:delete_auto_scaling_configuration, params) req.send_request() 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.
1019 1020 1021 1022 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1019 def delete_connection(params = {}, = {}) req = build_request(:delete_connection, params) req.send_request() 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.
1062 1063 1064 1065 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1062 def delete_observability_configuration(params = {}, = {}) req = build_request(:delete_observability_configuration, params) req.send_request() 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.
1140 1141 1142 1143 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1140 def delete_service(params = {}, = {}) req = build_request(:delete_service, params) req.send_request() 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.
1181 1182 1183 1184 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1181 def delete_vpc_connector(params = {}, = {}) req = build_request(:delete_vpc_connector, params) req.send_request() end |
#describe_auto_scaling_configuration(params = {}) ⇒ Types::DescribeAutoScalingConfigurationResponse
Return a full description of an App Runner automatic scaling configuration resource.
1224 1225 1226 1227 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1224 def describe_auto_scaling_configuration(params = {}, = {}) req = build_request(:describe_auto_scaling_configuration, params) req.send_request() 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.
1288 1289 1290 1291 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1288 def describe_custom_domains(params = {}, = {}) req = build_request(:describe_custom_domains, params) req.send_request() end |
#describe_observability_configuration(params = {}) ⇒ Types::DescribeObservabilityConfigurationResponse
Return a full description of an App Runner observability configuration resource.
1329 1330 1331 1332 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1329 def describe_observability_configuration(params = {}, = {}) req = build_request(:describe_observability_configuration, params) req.send_request() end |
#describe_service(params = {}) ⇒ Types::DescribeServiceResponse
Return a full description of an App Runner service.
1401 1402 1403 1404 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1401 def describe_service(params = {}, = {}) req = build_request(:describe_service, params) req.send_request() end |
#describe_vpc_connector(params = {}) ⇒ Types::DescribeVpcConnectorResponse
Return a description of an App Runner VPC connector resource.
1441 1442 1443 1444 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1441 def describe_vpc_connector(params = {}, = {}) req = build_request(:describe_vpc_connector, params) req.send_request() 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.
1496 1497 1498 1499 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1496 def disassociate_custom_domain(params = {}, = {}) req = build_request(:disassociate_custom_domain, params) req.send_request() 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.
1570 1571 1572 1573 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1570 def list_auto_scaling_configurations(params = {}, = {}) req = build_request(:list_auto_scaling_configurations, params) req.send_request() 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.
1626 1627 1628 1629 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1626 def list_connections(params = {}, = {}) req = build_request(:list_connections, params) req.send_request() 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.
1700 1701 1702 1703 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1700 def list_observability_configurations(params = {}, = {}) req = build_request(:list_observability_configurations, params) req.send_request() 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.
1762 1763 1764 1765 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1762 def list_operations(params = {}, = {}) req = build_request(:list_operations, params) req.send_request() 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.
1815 1816 1817 1818 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1815 def list_services(params = {}, = {}) req = build_request(:list_services, params) req.send_request() 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.
1849 1850 1851 1852 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1849 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() 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.
1906 1907 1908 1909 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1906 def list_vpc_connectors(params = {}, = {}) req = build_request(:list_vpc_connectors, params) req.send_request() 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.
1986 1987 1988 1989 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 1986 def pause_service(params = {}, = {}) req = build_request(:pause_service, params) req.send_request() 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.
2065 2066 2067 2068 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 2065 def resume_service(params = {}, = {}) req = build_request(:resume_service, params) req.send_request() 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.
2106 2107 2108 2109 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 2106 def start_deployment(params = {}, = {}) req = build_request(:start_deployment, params) req.send_request() 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.
2143 2144 2145 2146 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 2143 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove tags from an App Runner resource.
2172 2173 2174 2175 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 2172 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() 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.
2351 2352 2353 2354 |
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb', line 2351 def update_service(params = {}, = {}) req = build_request(:update_service, params) req.send_request() end |