Struct aws_sdk_apprunner::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS App Runner
Client for invoking operations on AWS App Runner. Each operation on AWS App Runner is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_apprunner::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_apprunner::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_apprunner::Client::from_conf(config);
Implementations§
source§impl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
source§impl Client
impl Client
sourcepub fn associate_custom_domain(&self) -> AssociateCustomDomain
pub fn associate_custom_domain(&self) -> AssociateCustomDomain
Constructs a fluent builder for the AssociateCustomDomain
operation.
- The fluent builder is configurable:
service_arn(impl Into<String>)
/set_service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:A custom domain endpoint to associate. Specify a root domain (for example,
example.com
), a subdomain (for example,login.example.com
oradmin.login.example.com
), or a wildcard (for example,*.example.com
).enable_www_subdomain(bool)
/set_enable_www_subdomain(Option<bool>)
:Set to
true
to associate the subdomainwww.DomainName
with the App Runner service in addition to the base domain.Default:
true
- On success, responds with
AssociateCustomDomainOutput
with field(s):dns_target(Option<String>)
:The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.
service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.
custom_domain(Option<CustomDomain>)
:A description of the domain name that’s being associated.
vpc_dns_targets(Option<Vec<VpcDnsTarget>>)
:DNS Target records for the custom domains of this Amazon VPC.
- On failure, responds with
SdkError<AssociateCustomDomainError>
sourcepub fn create_auto_scaling_configuration(
&self
) -> CreateAutoScalingConfiguration
pub fn create_auto_scaling_configuration(
&self
) -> CreateAutoScalingConfiguration
Constructs a fluent builder for the CreateAutoScalingConfiguration
operation.
- The fluent builder is configurable:
auto_scaling_configuration_name(impl Into<String>)
/set_auto_scaling_configuration_name(Option<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.The name
DefaultConfiguration
is reserved (it’s the configuration that App Runner uses if you don’t provide a custome one). You can’t use it to create a new auto scaling configuration, and you can’t create a revision of it.When you want to use your own auto scaling configuration for your App Runner service, create a configuration with a different name, and then provide it when you create or update your service.
max_concurrency(i32)
/set_max_concurrency(Option<i32>)
: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(i32)
/set_min_size(Option<i32>)
: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(i32)
/set_max_size(Option<i32>)
:The maximum number of instances that your service scales up to. At most
MaxSize
instances actively serve traffic for your service.Default:
25
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.
- On success, responds with
CreateAutoScalingConfigurationOutput
with field(s):auto_scaling_configuration(Option<AutoScalingConfiguration>)
:A description of the App Runner auto scaling configuration that’s created by this request.
- On failure, responds with
SdkError<CreateAutoScalingConfigurationError>
sourcepub fn create_connection(&self) -> CreateConnection
pub fn create_connection(&self) -> CreateConnection
Constructs a fluent builder for the CreateConnection
operation.
- The fluent builder is configurable:
connection_name(impl Into<String>)
/set_connection_name(Option<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(ProviderType)
/set_provider_type(Option<ProviderType>)
:The source repository provider.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.
- On success, responds with
CreateConnectionOutput
with field(s):connection(Option<Connection>)
:A description of the App Runner connection that’s created by this request.
- On failure, responds with
SdkError<CreateConnectionError>
sourcepub fn create_observability_configuration(
&self
) -> CreateObservabilityConfiguration
pub fn create_observability_configuration(
&self
) -> CreateObservabilityConfiguration
Constructs a fluent builder for the CreateObservabilityConfiguration
operation.
- The fluent builder is configurable:
observability_configuration_name(impl Into<String>)
/set_observability_configuration_name(Option<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.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.
trace_configuration(TraceConfiguration)
/set_trace_configuration(Option<TraceConfiguration>)
:The configuration of the tracing feature within this observability configuration. If you don’t specify it, App Runner doesn’t enable tracing.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.
- On success, responds with
CreateObservabilityConfigurationOutput
with field(s):observability_configuration(Option<ObservabilityConfiguration>)
:A description of the App Runner observability configuration that’s created by this request.
- On failure, responds with
SdkError<CreateObservabilityConfigurationError>
sourcepub fn create_service(&self) -> CreateService
pub fn create_service(&self) -> CreateService
Constructs a fluent builder for the CreateService
operation.
- The fluent builder is configurable:
service_name(impl Into<String>)
/set_service_name(Option<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(SourceConfiguration)
/set_source_configuration(Option<SourceConfiguration>)
:The source to deploy to the App Runner service. It can be a code or an image repository.
instance_configuration(InstanceConfiguration)
/set_instance_configuration(Option<InstanceConfiguration>)
:The runtime configuration of instances (scaling units) of your service.
tags(Vec<Tag>)
/set_tags(Option<Vec<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(EncryptionConfiguration)
/set_encryption_configuration(Option<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(HealthCheckConfiguration)
/set_health_check_configuration(Option<HealthCheckConfiguration>)
:The settings for the health check that App Runner performs to monitor the health of the App Runner service.
auto_scaling_configuration_arn(impl Into<String>)
/set_auto_scaling_configuration_arn(Option<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(NetworkConfiguration)
/set_network_configuration(Option<NetworkConfiguration>)
:Configuration settings related to network traffic of the web application that the App Runner service runs.
observability_configuration(ServiceObservabilityConfiguration)
/set_observability_configuration(Option<ServiceObservabilityConfiguration>)
:The observability configuration of your service.
- On success, responds with
CreateServiceOutput
with field(s):service(Option<Service>)
:A description of the App Runner service that’s created by this request.
operation_id(Option<String>)
:The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation’s progress.
- On failure, responds with
SdkError<CreateServiceError>
sourcepub fn create_vpc_connector(&self) -> CreateVpcConnector
pub fn create_vpc_connector(&self) -> CreateVpcConnector
Constructs a fluent builder for the CreateVpcConnector
operation.
- The fluent builder is configurable:
vpc_connector_name(impl Into<String>)
/set_vpc_connector_name(Option<String>)
:A name for the VPC connector.
subnets(Vec<String>)
/set_subnets(Option<Vec<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.
App Runner currently only provides support for IPv4.
security_groups(Vec<String>)
/set_security_groups(Option<Vec<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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
- On success, responds with
CreateVpcConnectorOutput
with field(s):vpc_connector(Option<VpcConnector>)
:A description of the App Runner VPC connector that’s created by this request.
- On failure, responds with
SdkError<CreateVpcConnectorError>
sourcepub fn create_vpc_ingress_connection(&self) -> CreateVpcIngressConnection
pub fn create_vpc_ingress_connection(&self) -> CreateVpcIngressConnection
Constructs a fluent builder for the CreateVpcIngressConnection
operation.
- The fluent builder is configurable:
service_arn(impl Into<String>)
/set_service_arn(Option<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(impl Into<String>)
/set_vpc_ingress_connection_name(Option<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(IngressVpcConfiguration)
/set_ingress_vpc_configuration(Option<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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:An optional list of metadata items that you can associate with the VPC Ingress Connection resource. A tag is a key-value pair.
- On success, responds with
CreateVpcIngressConnectionOutput
with field(s):vpc_ingress_connection(Option<VpcIngressConnection>)
:A description of the App Runner VPC Ingress Connection resource that’s created by this request.
- On failure, responds with
SdkError<CreateVpcIngressConnectionError>
sourcepub fn delete_auto_scaling_configuration(
&self
) -> DeleteAutoScalingConfiguration
pub fn delete_auto_scaling_configuration(
&self
) -> DeleteAutoScalingConfiguration
Constructs a fluent builder for the DeleteAutoScalingConfiguration
operation.
- The fluent builder is configurable:
auto_scaling_configuration_arn(impl Into<String>)
/set_auto_scaling_configuration_arn(Option<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.
- On success, responds with
DeleteAutoScalingConfigurationOutput
with field(s):auto_scaling_configuration(Option<AutoScalingConfiguration>)
:A description of the App Runner auto scaling configuration that this request just deleted.
- On failure, responds with
SdkError<DeleteAutoScalingConfigurationError>
sourcepub fn delete_connection(&self) -> DeleteConnection
pub fn delete_connection(&self) -> DeleteConnection
Constructs a fluent builder for the DeleteConnection
operation.
- The fluent builder is configurable:
connection_arn(impl Into<String>)
/set_connection_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.
- On success, responds with
DeleteConnectionOutput
with field(s):connection(Option<Connection>)
:A description of the App Runner connection that this request just deleted.
- On failure, responds with
SdkError<DeleteConnectionError>
sourcepub fn delete_observability_configuration(
&self
) -> DeleteObservabilityConfiguration
pub fn delete_observability_configuration(
&self
) -> DeleteObservabilityConfiguration
Constructs a fluent builder for the DeleteObservabilityConfiguration
operation.
- The fluent builder is configurable:
observability_configuration_arn(impl Into<String>)
/set_observability_configuration_arn(Option<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.
- On success, responds with
DeleteObservabilityConfigurationOutput
with field(s):observability_configuration(Option<ObservabilityConfiguration>)
:A description of the App Runner observability configuration that this request just deleted.
- On failure, responds with
SdkError<DeleteObservabilityConfigurationError>
sourcepub fn delete_service(&self) -> DeleteService
pub fn delete_service(&self) -> DeleteService
Constructs a fluent builder for the DeleteService
operation.
- The fluent builder is configurable:
service_arn(impl Into<String>)
/set_service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner service that you want to delete.
- On success, responds with
DeleteServiceOutput
with field(s):service(Option<Service>)
:A description of the App Runner service that this request just deleted.
operation_id(Option<String>)
:The unique ID of the asynchronous operation that this request started. You can use it combined with the
ListOperations
call to track the operation’s progress.
- On failure, responds with
SdkError<DeleteServiceError>
sourcepub fn delete_vpc_connector(&self) -> DeleteVpcConnector
pub fn delete_vpc_connector(&self) -> DeleteVpcConnector
Constructs a fluent builder for the DeleteVpcConnector
operation.
- The fluent builder is configurable:
vpc_connector_arn(impl Into<String>)
/set_vpc_connector_arn(Option<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.
- On success, responds with
DeleteVpcConnectorOutput
with field(s):vpc_connector(Option<VpcConnector>)
:A description of the App Runner VPC connector that this request just deleted.
- On failure, responds with
SdkError<DeleteVpcConnectorError>
sourcepub fn delete_vpc_ingress_connection(&self) -> DeleteVpcIngressConnection
pub fn delete_vpc_ingress_connection(&self) -> DeleteVpcIngressConnection
Constructs a fluent builder for the DeleteVpcIngressConnection
operation.
- The fluent builder is configurable:
vpc_ingress_connection_arn(impl Into<String>)
/set_vpc_ingress_connection_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want to delete.
- On success, responds with
DeleteVpcIngressConnectionOutput
with field(s):vpc_ingress_connection(Option<VpcIngressConnection>)
:A description of the App Runner VPC Ingress Connection that this request just deleted.
- On failure, responds with
SdkError<DeleteVpcIngressConnectionError>
sourcepub fn describe_auto_scaling_configuration(
&self
) -> DescribeAutoScalingConfiguration
pub fn describe_auto_scaling_configuration(
&self
) -> DescribeAutoScalingConfiguration
Constructs a fluent builder for the DescribeAutoScalingConfiguration
operation.
- The fluent builder is configurable:
auto_scaling_configuration_arn(impl Into<String>)
/set_auto_scaling_configuration_arn(Option<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.
- On success, responds with
DescribeAutoScalingConfigurationOutput
with field(s):auto_scaling_configuration(Option<AutoScalingConfiguration>)
:A full description of the App Runner auto scaling configuration that you specified in this request.
- On failure, responds with
SdkError<DescribeAutoScalingConfigurationError>
sourcepub fn describe_custom_domains(&self) -> DescribeCustomDomains
pub fn describe_custom_domains(&self) -> DescribeCustomDomains
Constructs a fluent builder for the DescribeCustomDomains
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
service_arn(impl Into<String>)
/set_service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.
next_token(impl Into<String>)
/set_next_token(Option<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(i32)
/set_max_results(Option<i32>)
: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.
- On success, responds with
DescribeCustomDomainsOutput
with field(s):dns_target(Option<String>)
:The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.
service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.
custom_domains(Option<Vec<CustomDomain>>)
:A list of descriptions of custom domain names that are associated with the service. In a paginated request, the request returns up to
MaxResults
records per call.vpc_dns_targets(Option<Vec<VpcDnsTarget>>)
:DNS Target records for the custom domains of this Amazon VPC.
next_token(Option<String>)
:The token that you can pass in a subsequent request to get the next result page. It’s returned in a paginated request.
- On failure, responds with
SdkError<DescribeCustomDomainsError>
sourcepub fn describe_observability_configuration(
&self
) -> DescribeObservabilityConfiguration
pub fn describe_observability_configuration(
&self
) -> DescribeObservabilityConfiguration
Constructs a fluent builder for the DescribeObservabilityConfiguration
operation.
- The fluent builder is configurable:
observability_configuration_arn(impl Into<String>)
/set_observability_configuration_arn(Option<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.
- On success, responds with
DescribeObservabilityConfigurationOutput
with field(s):observability_configuration(Option<ObservabilityConfiguration>)
:A full description of the App Runner observability configuration that you specified in this request.
- On failure, responds with
SdkError<DescribeObservabilityConfigurationError>
sourcepub fn describe_service(&self) -> DescribeService
pub fn describe_service(&self) -> DescribeService
Constructs a fluent builder for the DescribeService
operation.
- The fluent builder is configurable:
service_arn(impl Into<String>)
/set_service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner service that you want a description for.
- On success, responds with
DescribeServiceOutput
with field(s):service(Option<Service>)
:A full description of the App Runner service that you specified in this request.
- On failure, responds with
SdkError<DescribeServiceError>
sourcepub fn describe_vpc_connector(&self) -> DescribeVpcConnector
pub fn describe_vpc_connector(&self) -> DescribeVpcConnector
Constructs a fluent builder for the DescribeVpcConnector
operation.
- The fluent builder is configurable:
vpc_connector_arn(impl Into<String>)
/set_vpc_connector_arn(Option<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.
- On success, responds with
DescribeVpcConnectorOutput
with field(s):vpc_connector(Option<VpcConnector>)
:A description of the App Runner VPC connector that you specified in this request.
- On failure, responds with
SdkError<DescribeVpcConnectorError>
sourcepub fn describe_vpc_ingress_connection(&self) -> DescribeVpcIngressConnection
pub fn describe_vpc_ingress_connection(&self) -> DescribeVpcIngressConnection
Constructs a fluent builder for the DescribeVpcIngressConnection
operation.
- The fluent builder is configurable:
vpc_ingress_connection_arn(impl Into<String>)
/set_vpc_ingress_connection_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want a description for.
- On success, responds with
DescribeVpcIngressConnectionOutput
with field(s):vpc_ingress_connection(Option<VpcIngressConnection>)
:A description of the App Runner VPC Ingress Connection that you specified in this request.
- On failure, responds with
SdkError<DescribeVpcIngressConnectionError>
sourcepub fn disassociate_custom_domain(&self) -> DisassociateCustomDomain
pub fn disassociate_custom_domain(&self) -> DisassociateCustomDomain
Constructs a fluent builder for the DisassociateCustomDomain
operation.
- The fluent builder is configurable:
service_arn(impl Into<String>)
/set_service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:The domain name that you want to disassociate from the App Runner service.
- On success, responds with
DisassociateCustomDomainOutput
with field(s):dns_target(Option<String>)
:The App Runner subdomain of the App Runner service. The disassociated custom domain name was mapped to this target name.
service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner service that a custom domain name is disassociated from.
custom_domain(Option<CustomDomain>)
:A description of the domain name that’s being disassociated.
vpc_dns_targets(Option<Vec<VpcDnsTarget>>)
:DNS Target records for the custom domains of this Amazon VPC.
- On failure, responds with
SdkError<DisassociateCustomDomainError>
sourcepub fn list_auto_scaling_configurations(&self) -> ListAutoScalingConfigurations
pub fn list_auto_scaling_configurations(&self) -> ListAutoScalingConfigurations
Constructs a fluent builder for the ListAutoScalingConfigurations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
auto_scaling_configuration_name(impl Into<String>)
/set_auto_scaling_configuration_name(Option<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(bool)
/set_latest_only(bool)
: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(i32)
/set_max_results(Option<i32>)
: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(impl Into<String>)
/set_next_token(Option<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.
- On success, responds with
ListAutoScalingConfigurationsOutput
with field(s):auto_scaling_configuration_summary_list(Option<Vec<AutoScalingConfigurationSummary>>)
:A list of summary information records for auto scaling configurations. In a paginated request, the request returns up to
MaxResults
records for each call.next_token(Option<String>)
:The token that you can pass in a subsequent request to get the next result page. It’s returned in a paginated request.
- On failure, responds with
SdkError<ListAutoScalingConfigurationsError>
sourcepub fn list_connections(&self) -> ListConnections
pub fn list_connections(&self) -> ListConnections
Constructs a fluent builder for the ListConnections
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
connection_name(impl Into<String>)
/set_connection_name(Option<String>)
:If specified, only this connection is returned. If not specified, the result isn’t filtered by name.
max_results(i32)
/set_max_results(Option<i32>)
: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(impl Into<String>)
/set_next_token(Option<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.
- On success, responds with
ListConnectionsOutput
with field(s):connection_summary_list(Option<Vec<ConnectionSummary>>)
:A list of summary information records for connections. In a paginated request, the request returns up to
MaxResults
records for each call.next_token(Option<String>)
:The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request.
- On failure, responds with
SdkError<ListConnectionsError>
sourcepub fn list_observability_configurations(
&self
) -> ListObservabilityConfigurations
pub fn list_observability_configurations(
&self
) -> ListObservabilityConfigurations
Constructs a fluent builder for the ListObservabilityConfigurations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
observability_configuration_name(impl Into<String>)
/set_observability_configuration_name(Option<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(bool)
/set_latest_only(bool)
: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(i32)
/set_max_results(Option<i32>)
: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(impl Into<String>)
/set_next_token(Option<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.
- On success, responds with
ListObservabilityConfigurationsOutput
with field(s):observability_configuration_summary_list(Option<Vec<ObservabilityConfigurationSummary>>)
:A list of summary information records for observability configurations. In a paginated request, the request returns up to
MaxResults
records for each call.next_token(Option<String>)
:The token that you can pass in a subsequent request to get the next result page. It’s returned in a paginated request.
- On failure, responds with
SdkError<ListObservabilityConfigurationsError>
sourcepub fn list_operations(&self) -> ListOperations
pub fn list_operations(&self) -> ListOperations
Constructs a fluent builder for the ListOperations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
service_arn(impl Into<String>)
/set_service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner service that you want a list of operations for.
next_token(impl Into<String>)
/set_next_token(Option<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(i32)
/set_max_results(Option<i32>)
: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.
- On success, responds with
ListOperationsOutput
with field(s):operation_summary_list(Option<Vec<OperationSummary>>)
:A list of operation summary information records. In a paginated request, the request returns up to
MaxResults
records for each call.next_token(Option<String>)
:The token that you can pass in a subsequent request to get the next result page. It’s returned in a paginated request.
- On failure, responds with
SdkError<ListOperationsError>
sourcepub fn list_services(&self) -> ListServices
pub fn list_services(&self) -> ListServices
Constructs a fluent builder for the ListServices
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<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(i32)
/set_max_results(Option<i32>)
: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.
- On success, responds with
ListServicesOutput
with field(s):service_summary_list(Option<Vec<ServiceSummary>>)
:A list of service summary information records. In a paginated request, the request returns up to
MaxResults
records for each call.next_token(Option<String>)
:The token that you can pass in a subsequent request to get the next result page. It’s returned in a paginated request.
- On failure, responds with
SdkError<ListServicesError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<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.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec<Tag>>)
:A list of the tag key-value pairs that are associated with the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn list_vpc_connectors(&self) -> ListVpcConnectors
pub fn list_vpc_connectors(&self) -> ListVpcConnectors
Constructs a fluent builder for the ListVpcConnectors
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
: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(impl Into<String>)
/set_next_token(Option<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.
- On success, responds with
ListVpcConnectorsOutput
with field(s):vpc_connectors(Option<Vec<VpcConnector>>)
:A list of information records for VPC connectors. In a paginated request, the request returns up to
MaxResults
records for each call.next_token(Option<String>)
:The token that you can pass in a subsequent request to get the next result page. It’s returned in a paginated request.
- On failure, responds with
SdkError<ListVpcConnectorsError>
sourcepub fn list_vpc_ingress_connections(&self) -> ListVpcIngressConnections
pub fn list_vpc_ingress_connections(&self) -> ListVpcIngressConnections
Constructs a fluent builder for the ListVpcIngressConnections
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filter(ListVpcIngressConnectionsFilter)
/set_filter(Option<ListVpcIngressConnectionsFilter>)
:The VPC Ingress Connections to be listed based on either the Service Arn or Vpc Endpoint Id, or both.
max_results(i32)
/set_max_results(Option<i32>)
: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(impl Into<String>)
/set_next_token(Option<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.
- On success, responds with
ListVpcIngressConnectionsOutput
with field(s):vpc_ingress_connection_summary_list(Option<Vec<VpcIngressConnectionSummary>>)
:A list of summary information records for VPC Ingress Connections. In a paginated request, the request returns up to
MaxResults
records for each call.next_token(Option<String>)
:The token that you can pass in a subsequent request to get the next result page. It’s returned in a paginated request.
- On failure, responds with
SdkError<ListVpcIngressConnectionsError>
sourcepub fn pause_service(&self) -> PauseService
pub fn pause_service(&self) -> PauseService
Constructs a fluent builder for the PauseService
operation.
- The fluent builder is configurable:
service_arn(impl Into<String>)
/set_service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner service that you want to pause.
- On success, responds with
PauseServiceOutput
with field(s):service(Option<Service>)
:A description of the App Runner service that this request just paused.
operation_id(Option<String>)
:The unique ID of the asynchronous operation that this request started. You can use it combined with the
ListOperations
call to track the operation’s progress.
- On failure, responds with
SdkError<PauseServiceError>
sourcepub fn resume_service(&self) -> ResumeService
pub fn resume_service(&self) -> ResumeService
Constructs a fluent builder for the ResumeService
operation.
- The fluent builder is configurable:
service_arn(impl Into<String>)
/set_service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner service that you want to resume.
- On success, responds with
ResumeServiceOutput
with field(s):service(Option<Service>)
:A description of the App Runner service that this request just resumed.
operation_id(Option<String>)
:The unique ID of the asynchronous operation that this request started. You can use it combined with the
ListOperations
call to track the operation’s progress.
- On failure, responds with
SdkError<ResumeServiceError>
sourcepub fn start_deployment(&self) -> StartDeployment
pub fn start_deployment(&self) -> StartDeployment
Constructs a fluent builder for the StartDeployment
operation.
- The fluent builder is configurable:
service_arn(impl Into<String>)
/set_service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner service that you want to manually deploy to.
- On success, responds with
StartDeploymentOutput
with field(s):operation_id(Option<String>)
:The unique ID of the asynchronous operation that this request started. You can use it combined with the
ListOperations
call to track the operation’s progress.
- On failure, responds with
SdkError<StartDeploymentError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<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(Vec<Tag>)
/set_tags(Option<Vec<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.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<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(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:A list of tag keys that you want to remove.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_service(&self) -> UpdateService
pub fn update_service(&self) -> UpdateService
Constructs a fluent builder for the UpdateService
operation.
- The fluent builder is configurable:
service_arn(impl Into<String>)
/set_service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the App Runner service that you want to update.
source_configuration(SourceConfiguration)
/set_source_configuration(Option<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 eitherCodeRepository
orImageRepository
. To update the source configuration, set the values to members of the structure that you include.instance_configuration(InstanceConfiguration)
/set_instance_configuration(Option<InstanceConfiguration>)
:The runtime configuration to apply to instances (scaling units) of your service.
auto_scaling_configuration_arn(impl Into<String>)
/set_auto_scaling_configuration_arn(Option<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(HealthCheckConfiguration)
/set_health_check_configuration(Option<HealthCheckConfiguration>)
:The settings for the health check that App Runner performs to monitor the health of the App Runner service.
network_configuration(NetworkConfiguration)
/set_network_configuration(Option<NetworkConfiguration>)
:Configuration settings related to network traffic of the web application that the App Runner service runs.
observability_configuration(ServiceObservabilityConfiguration)
/set_observability_configuration(Option<ServiceObservabilityConfiguration>)
:The observability configuration of your service.
- On success, responds with
UpdateServiceOutput
with field(s):service(Option<Service>)
:A description of the App Runner service updated by this request. All configuration values in the returned
Service
structure reflect configuration changes that are being applied by this request.operation_id(Option<String>)
:The unique ID of the asynchronous operation that this request started. You can use it combined with the
ListOperations
call to track the operation’s progress.
- On failure, responds with
SdkError<UpdateServiceError>
sourcepub fn update_vpc_ingress_connection(&self) -> UpdateVpcIngressConnection
pub fn update_vpc_ingress_connection(&self) -> UpdateVpcIngressConnection
Constructs a fluent builder for the UpdateVpcIngressConnection
operation.
- The fluent builder is configurable:
vpc_ingress_connection_arn(impl Into<String>)
/set_vpc_ingress_connection_arn(Option<String>)
:The Amazon Resource Name (Arn) for the App Runner VPC Ingress Connection resource that you want to update.
ingress_vpc_configuration(IngressVpcConfiguration)
/set_ingress_vpc_configuration(Option<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.
- On success, responds with
UpdateVpcIngressConnectionOutput
with field(s):vpc_ingress_connection(Option<VpcIngressConnection>)
:A description of the App Runner VPC Ingress Connection resource that’s updated by this request.
- On failure, responds with
SdkError<UpdateVpcIngressConnectionError>
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it.
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
Panics
- This method will panic if the
conf
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
conf
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it.