amazonka-apprunner-2.0: Amazon App Runner SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AppRunner.Lens

Description

 
Synopsis

Operations

AssociateCustomDomain

associateCustomDomain_enableWWWSubdomain :: Lens' AssociateCustomDomain (Maybe Bool) Source #

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

Default: true

associateCustomDomain_serviceArn :: Lens' AssociateCustomDomain Text Source #

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

associateCustomDomain_domainName :: Lens' AssociateCustomDomain Text Source #

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

associateCustomDomainResponse_dNSTarget :: Lens' AssociateCustomDomainResponse Text Source #

The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.

associateCustomDomainResponse_serviceArn :: Lens' AssociateCustomDomainResponse Text Source #

The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.

associateCustomDomainResponse_customDomain :: Lens' AssociateCustomDomainResponse CustomDomain Source #

A description of the domain name that's being associated.

associateCustomDomainResponse_vpcDNSTargets :: Lens' AssociateCustomDomainResponse [VpcDNSTarget] Source #

DNS Target records for the custom domains of this Amazon VPC.

CreateAutoScalingConfiguration

createAutoScalingConfiguration_maxConcurrency :: Lens' CreateAutoScalingConfiguration (Maybe Natural) Source #

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

createAutoScalingConfiguration_maxSize :: Lens' CreateAutoScalingConfiguration (Maybe Natural) Source #

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

Default: 25

createAutoScalingConfiguration_minSize :: Lens' CreateAutoScalingConfiguration (Maybe Natural) Source #

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

createAutoScalingConfiguration_tags :: Lens' CreateAutoScalingConfiguration (Maybe [Tag]) Source #

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

createAutoScalingConfiguration_autoScalingConfigurationName :: Lens' CreateAutoScalingConfiguration Text Source #

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.

createAutoScalingConfigurationResponse_autoScalingConfiguration :: Lens' CreateAutoScalingConfigurationResponse AutoScalingConfiguration Source #

A description of the App Runner auto scaling configuration that's created by this request.

CreateConnection

createConnection_tags :: Lens' CreateConnection (Maybe [Tag]) Source #

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

createConnection_connectionName :: Lens' CreateConnection Text Source #

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.

createConnectionResponse_connection :: Lens' CreateConnectionResponse Connection Source #

A description of the App Runner connection that's created by this request.

CreateObservabilityConfiguration

createObservabilityConfiguration_tags :: Lens' CreateObservabilityConfiguration (Maybe [Tag]) Source #

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

createObservabilityConfiguration_traceConfiguration :: Lens' CreateObservabilityConfiguration (Maybe TraceConfiguration) Source #

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

createObservabilityConfiguration_observabilityConfigurationName :: Lens' CreateObservabilityConfiguration Text Source #

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.

createObservabilityConfigurationResponse_observabilityConfiguration :: Lens' CreateObservabilityConfigurationResponse ObservabilityConfiguration Source #

A description of the App Runner observability configuration that's created by this request.

CreateService

createService_autoScalingConfigurationArn :: Lens' CreateService (Maybe Text) Source #

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

createService_encryptionConfiguration :: Lens' CreateService (Maybe EncryptionConfiguration) Source #

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.

createService_healthCheckConfiguration :: Lens' CreateService (Maybe HealthCheckConfiguration) Source #

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

createService_instanceConfiguration :: Lens' CreateService (Maybe InstanceConfiguration) Source #

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

createService_networkConfiguration :: Lens' CreateService (Maybe NetworkConfiguration) Source #

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

createService_tags :: Lens' CreateService (Maybe [Tag]) Source #

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

createService_serviceName :: Lens' CreateService Text Source #

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.

createService_sourceConfiguration :: Lens' CreateService SourceConfiguration Source #

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

createServiceResponse_service :: Lens' CreateServiceResponse Service Source #

A description of the App Runner service that's created by this request.

createServiceResponse_operationId :: Lens' CreateServiceResponse Text Source #

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.

CreateVpcConnector

createVpcConnector_securityGroups :: Lens' CreateVpcConnector (Maybe [Text]) Source #

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.

createVpcConnector_tags :: Lens' CreateVpcConnector (Maybe [Tag]) Source #

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

createVpcConnector_subnets :: Lens' CreateVpcConnector [Text] Source #

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.

createVpcConnectorResponse_vpcConnector :: Lens' CreateVpcConnectorResponse VpcConnector Source #

A description of the App Runner VPC connector that's created by this request.

CreateVpcIngressConnection

createVpcIngressConnection_tags :: Lens' CreateVpcIngressConnection (Maybe [Tag]) Source #

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

createVpcIngressConnection_serviceArn :: Lens' CreateVpcIngressConnection Text Source #

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

createVpcIngressConnection_vpcIngressConnectionName :: Lens' CreateVpcIngressConnection Text Source #

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.

createVpcIngressConnection_ingressVpcConfiguration :: Lens' CreateVpcIngressConnection IngressVpcConfiguration Source #

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.

createVpcIngressConnectionResponse_vpcIngressConnection :: Lens' CreateVpcIngressConnectionResponse VpcIngressConnection Source #

A description of the App Runner VPC Ingress Connection resource that's created by this request.

DeleteAutoScalingConfiguration

deleteAutoScalingConfiguration_autoScalingConfigurationArn :: Lens' DeleteAutoScalingConfiguration Text Source #

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.

deleteAutoScalingConfigurationResponse_autoScalingConfiguration :: Lens' DeleteAutoScalingConfigurationResponse AutoScalingConfiguration Source #

A description of the App Runner auto scaling configuration that this request just deleted.

DeleteConnection

deleteConnection_connectionArn :: Lens' DeleteConnection Text Source #

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

deleteConnectionResponse_connection :: Lens' DeleteConnectionResponse (Maybe Connection) Source #

A description of the App Runner connection that this request just deleted.

DeleteObservabilityConfiguration

deleteObservabilityConfiguration_observabilityConfigurationArn :: Lens' DeleteObservabilityConfiguration Text Source #

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.

deleteObservabilityConfigurationResponse_observabilityConfiguration :: Lens' DeleteObservabilityConfigurationResponse ObservabilityConfiguration Source #

A description of the App Runner observability configuration that this request just deleted.

DeleteService

deleteService_serviceArn :: Lens' DeleteService Text Source #

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

deleteServiceResponse_service :: Lens' DeleteServiceResponse Service Source #

A description of the App Runner service that this request just deleted.

deleteServiceResponse_operationId :: Lens' DeleteServiceResponse Text Source #

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.

DeleteVpcConnector

deleteVpcConnector_vpcConnectorArn :: Lens' DeleteVpcConnector Text Source #

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.

deleteVpcConnectorResponse_vpcConnector :: Lens' DeleteVpcConnectorResponse VpcConnector Source #

A description of the App Runner VPC connector that this request just deleted.

DeleteVpcIngressConnection

deleteVpcIngressConnection_vpcIngressConnectionArn :: Lens' DeleteVpcIngressConnection Text Source #

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

deleteVpcIngressConnectionResponse_vpcIngressConnection :: Lens' DeleteVpcIngressConnectionResponse VpcIngressConnection Source #

A description of the App Runner VPC Ingress Connection that this request just deleted.

DescribeAutoScalingConfiguration

describeAutoScalingConfiguration_autoScalingConfigurationArn :: Lens' DescribeAutoScalingConfiguration Text Source #

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.

describeAutoScalingConfigurationResponse_autoScalingConfiguration :: Lens' DescribeAutoScalingConfigurationResponse AutoScalingConfiguration Source #

A full description of the App Runner auto scaling configuration that you specified in this request.

DescribeCustomDomains

describeCustomDomains_maxResults :: Lens' DescribeCustomDomains (Maybe Natural) Source #

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.

describeCustomDomains_nextToken :: Lens' DescribeCustomDomains (Maybe Text) Source #

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.

describeCustomDomains_serviceArn :: Lens' DescribeCustomDomains Text Source #

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

describeCustomDomainsResponse_nextToken :: Lens' DescribeCustomDomainsResponse (Maybe Text) Source #

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

describeCustomDomainsResponse_dNSTarget :: Lens' DescribeCustomDomainsResponse Text Source #

The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.

describeCustomDomainsResponse_serviceArn :: Lens' DescribeCustomDomainsResponse Text Source #

The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.

describeCustomDomainsResponse_customDomains :: Lens' DescribeCustomDomainsResponse [CustomDomain] Source #

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.

describeCustomDomainsResponse_vpcDNSTargets :: Lens' DescribeCustomDomainsResponse [VpcDNSTarget] Source #

DNS Target records for the custom domains of this Amazon VPC.

DescribeObservabilityConfiguration

describeObservabilityConfiguration_observabilityConfigurationArn :: Lens' DescribeObservabilityConfiguration Text Source #

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.

describeObservabilityConfigurationResponse_observabilityConfiguration :: Lens' DescribeObservabilityConfigurationResponse ObservabilityConfiguration Source #

A full description of the App Runner observability configuration that you specified in this request.

DescribeService

describeService_serviceArn :: Lens' DescribeService Text Source #

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

describeServiceResponse_service :: Lens' DescribeServiceResponse Service Source #

A full description of the App Runner service that you specified in this request.

DescribeVpcConnector

describeVpcConnector_vpcConnectorArn :: Lens' DescribeVpcConnector Text Source #

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.

describeVpcConnectorResponse_vpcConnector :: Lens' DescribeVpcConnectorResponse VpcConnector Source #

A description of the App Runner VPC connector that you specified in this request.

DescribeVpcIngressConnection

describeVpcIngressConnection_vpcIngressConnectionArn :: Lens' DescribeVpcIngressConnection Text Source #

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

describeVpcIngressConnectionResponse_vpcIngressConnection :: Lens' DescribeVpcIngressConnectionResponse VpcIngressConnection Source #

A description of the App Runner VPC Ingress Connection that you specified in this request.

DisassociateCustomDomain

disassociateCustomDomain_serviceArn :: Lens' DisassociateCustomDomain Text Source #

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

disassociateCustomDomain_domainName :: Lens' DisassociateCustomDomain Text Source #

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

disassociateCustomDomainResponse_dNSTarget :: Lens' DisassociateCustomDomainResponse Text Source #

The App Runner subdomain of the App Runner service. The disassociated custom domain name was mapped to this target name.

disassociateCustomDomainResponse_serviceArn :: Lens' DisassociateCustomDomainResponse Text Source #

The Amazon Resource Name (ARN) of the App Runner service that a custom domain name is disassociated from.

disassociateCustomDomainResponse_customDomain :: Lens' DisassociateCustomDomainResponse CustomDomain Source #

A description of the domain name that's being disassociated.

disassociateCustomDomainResponse_vpcDNSTargets :: Lens' DisassociateCustomDomainResponse [VpcDNSTarget] Source #

DNS Target records for the custom domains of this Amazon VPC.

ListAutoScalingConfigurations

listAutoScalingConfigurations_autoScalingConfigurationName :: Lens' ListAutoScalingConfigurations (Maybe Text) Source #

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.

listAutoScalingConfigurations_latestOnly :: Lens' ListAutoScalingConfigurations (Maybe Bool) Source #

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

listAutoScalingConfigurations_maxResults :: Lens' ListAutoScalingConfigurations (Maybe Natural) Source #

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.

listAutoScalingConfigurations_nextToken :: Lens' ListAutoScalingConfigurations (Maybe Text) Source #

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.

listAutoScalingConfigurationsResponse_nextToken :: Lens' ListAutoScalingConfigurationsResponse (Maybe Text) Source #

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

listAutoScalingConfigurationsResponse_autoScalingConfigurationSummaryList :: Lens' ListAutoScalingConfigurationsResponse [AutoScalingConfigurationSummary] Source #

A list of summary information records for auto scaling configurations. In a paginated request, the request returns up to MaxResults records for each call.

ListConnections

listConnections_connectionName :: Lens' ListConnections (Maybe Text) Source #

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

listConnections_maxResults :: Lens' ListConnections (Maybe Natural) Source #

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.

listConnections_nextToken :: Lens' ListConnections (Maybe Text) Source #

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.

listConnectionsResponse_nextToken :: Lens' ListConnectionsResponse (Maybe Text) Source #

The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request.

listConnectionsResponse_connectionSummaryList :: Lens' ListConnectionsResponse [ConnectionSummary] Source #

A list of summary information records for connections. In a paginated request, the request returns up to MaxResults records for each call.

ListObservabilityConfigurations

listObservabilityConfigurations_latestOnly :: Lens' ListObservabilityConfigurations (Maybe Bool) Source #

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

listObservabilityConfigurations_maxResults :: Lens' ListObservabilityConfigurations (Maybe Natural) Source #

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.

listObservabilityConfigurations_nextToken :: Lens' ListObservabilityConfigurations (Maybe Text) Source #

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.

listObservabilityConfigurations_observabilityConfigurationName :: Lens' ListObservabilityConfigurations (Maybe Text) Source #

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.

listObservabilityConfigurationsResponse_nextToken :: Lens' ListObservabilityConfigurationsResponse (Maybe Text) Source #

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

listObservabilityConfigurationsResponse_observabilityConfigurationSummaryList :: Lens' ListObservabilityConfigurationsResponse [ObservabilityConfigurationSummary] Source #

A list of summary information records for observability configurations. In a paginated request, the request returns up to MaxResults records for each call.

ListOperations

listOperations_maxResults :: Lens' ListOperations (Maybe Natural) Source #

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.

listOperations_nextToken :: Lens' ListOperations (Maybe Text) Source #

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.

listOperations_serviceArn :: Lens' ListOperations Text Source #

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

listOperationsResponse_nextToken :: Lens' ListOperationsResponse (Maybe Text) Source #

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

listOperationsResponse_operationSummaryList :: Lens' ListOperationsResponse (Maybe [OperationSummary]) Source #

A list of operation summary information records. In a paginated request, the request returns up to MaxResults records for each call.

ListServices

listServices_maxResults :: Lens' ListServices (Maybe Natural) Source #

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.

listServices_nextToken :: Lens' ListServices (Maybe Text) Source #

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.

listServicesResponse_nextToken :: Lens' ListServicesResponse (Maybe Text) Source #

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

listServicesResponse_serviceSummaryList :: Lens' ListServicesResponse [ServiceSummary] Source #

A list of service summary information records. In a paginated request, the request returns up to MaxResults records for each call.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

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.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

A list of the tag key-value pairs that are associated with the resource.

ListVpcConnectors

listVpcConnectors_maxResults :: Lens' ListVpcConnectors (Maybe Natural) Source #

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.

listVpcConnectors_nextToken :: Lens' ListVpcConnectors (Maybe Text) Source #

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.

listVpcConnectorsResponse_nextToken :: Lens' ListVpcConnectorsResponse (Maybe Text) Source #

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

listVpcConnectorsResponse_vpcConnectors :: Lens' ListVpcConnectorsResponse [VpcConnector] Source #

A list of information records for VPC connectors. In a paginated request, the request returns up to MaxResults records for each call.

ListVpcIngressConnections

listVpcIngressConnections_filter :: Lens' ListVpcIngressConnections (Maybe ListVpcIngressConnectionsFilter) Source #

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

listVpcIngressConnections_maxResults :: Lens' ListVpcIngressConnections (Maybe Natural) Source #

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.

listVpcIngressConnections_nextToken :: Lens' ListVpcIngressConnections (Maybe Text) Source #

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.

listVpcIngressConnectionsResponse_nextToken :: Lens' ListVpcIngressConnectionsResponse (Maybe Text) Source #

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

listVpcIngressConnectionsResponse_vpcIngressConnectionSummaryList :: Lens' ListVpcIngressConnectionsResponse [VpcIngressConnectionSummary] Source #

A list of summary information records for VPC Ingress Connections. In a paginated request, the request returns up to MaxResults records for each call.

PauseService

pauseService_serviceArn :: Lens' PauseService Text Source #

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

pauseServiceResponse_operationId :: Lens' PauseServiceResponse (Maybe Text) Source #

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.

pauseServiceResponse_service :: Lens' PauseServiceResponse Service Source #

A description of the App Runner service that this request just paused.

ResumeService

resumeService_serviceArn :: Lens' ResumeService Text Source #

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

resumeServiceResponse_operationId :: Lens' ResumeServiceResponse (Maybe Text) Source #

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.

resumeServiceResponse_service :: Lens' ResumeServiceResponse Service Source #

A description of the App Runner service that this request just resumed.

StartDeployment

startDeployment_serviceArn :: Lens' StartDeployment Text Source #

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

startDeploymentResponse_operationId :: Lens' StartDeploymentResponse Text Source #

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.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

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.

tagResource_tags :: Lens' TagResource [Tag] Source #

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.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

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.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A list of tag keys that you want to remove.

UpdateService

updateService_autoScalingConfigurationArn :: Lens' UpdateService (Maybe Text) Source #

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

updateService_healthCheckConfiguration :: Lens' UpdateService (Maybe HealthCheckConfiguration) Source #

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

updateService_instanceConfiguration :: Lens' UpdateService (Maybe InstanceConfiguration) Source #

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

updateService_networkConfiguration :: Lens' UpdateService (Maybe NetworkConfiguration) Source #

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

updateService_sourceConfiguration :: Lens' UpdateService (Maybe SourceConfiguration) Source #

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.

updateService_serviceArn :: Lens' UpdateService Text Source #

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

updateServiceResponse_service :: Lens' UpdateServiceResponse Service Source #

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.

updateServiceResponse_operationId :: Lens' UpdateServiceResponse Text Source #

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.

UpdateVpcIngressConnection

updateVpcIngressConnection_vpcIngressConnectionArn :: Lens' UpdateVpcIngressConnection Text Source #

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

updateVpcIngressConnection_ingressVpcConfiguration :: Lens' UpdateVpcIngressConnection IngressVpcConfiguration Source #

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.

updateVpcIngressConnectionResponse_vpcIngressConnection :: Lens' UpdateVpcIngressConnectionResponse VpcIngressConnection Source #

A description of the App Runner VPC Ingress Connection resource that's updated by this request.

Types

AuthenticationConfiguration

authenticationConfiguration_accessRoleArn :: Lens' AuthenticationConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories (but not for ECR Public repositories).

authenticationConfiguration_connectionArn :: Lens' AuthenticationConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code repositories.

AutoScalingConfiguration

autoScalingConfiguration_autoScalingConfigurationArn :: Lens' AutoScalingConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of this auto scaling configuration.

autoScalingConfiguration_autoScalingConfigurationName :: Lens' AutoScalingConfiguration (Maybe Text) Source #

The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

autoScalingConfiguration_autoScalingConfigurationRevision :: Lens' AutoScalingConfiguration (Maybe Int) Source #

The revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") that share the same AutoScalingConfigurationName.

autoScalingConfiguration_createdAt :: Lens' AutoScalingConfiguration (Maybe UTCTime) Source #

The time when the auto scaling configuration was created. It's in Unix time stamp format.

autoScalingConfiguration_deletedAt :: Lens' AutoScalingConfiguration (Maybe UTCTime) Source #

The time when the auto scaling configuration was deleted. It's in Unix time stamp format.

autoScalingConfiguration_latest :: Lens' AutoScalingConfiguration (Maybe Bool) Source #

It's set to true for the configuration with the highest Revision among all configurations that share the same AutoScalingConfigurationName. It's set to false otherwise.

autoScalingConfiguration_maxConcurrency :: Lens' AutoScalingConfiguration (Maybe Int) Source #

The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up.

autoScalingConfiguration_maxSize :: Lens' AutoScalingConfiguration (Maybe Int) Source #

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

autoScalingConfiguration_minSize :: Lens' AutoScalingConfiguration (Maybe Int) Source #

The minimum number of instances that App Runner provisions for a 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.

autoScalingConfiguration_status :: Lens' AutoScalingConfiguration (Maybe AutoScalingConfigurationStatus) Source #

The current state of the auto scaling configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted.

AutoScalingConfigurationSummary

autoScalingConfigurationSummary_autoScalingConfigurationArn :: Lens' AutoScalingConfigurationSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of this auto scaling configuration.

autoScalingConfigurationSummary_autoScalingConfigurationName :: Lens' AutoScalingConfigurationSummary (Maybe Text) Source #

The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

autoScalingConfigurationSummary_autoScalingConfigurationRevision :: Lens' AutoScalingConfigurationSummary (Maybe Int) Source #

The revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") with the same AutoScalingConfigurationName.

CertificateValidationRecord

certificateValidationRecord_status :: Lens' CertificateValidationRecord (Maybe CertificateValidationRecordStatus) Source #

The current state of the certificate CNAME record validation. It should change to SUCCESS after App Runner completes validation with your DNS.

CodeConfiguration

codeConfiguration_codeConfigurationValues :: Lens' CodeConfiguration (Maybe CodeConfigurationValues) Source #

The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a apprunner.yaml file in the source code repository (or ignoring the file if it exists).

codeConfiguration_configurationSource :: Lens' CodeConfiguration ConfigurationSource Source #

The source of the App Runner configuration. Values are interpreted as follows:

  • REPOSITORY – App Runner reads configuration values from the apprunner.yaml file in the source code repository and ignores CodeConfigurationValues.
  • API – App Runner uses configuration values provided in CodeConfigurationValues and ignores the apprunner.yaml file in the source code repository.

CodeConfigurationValues

codeConfigurationValues_buildCommand :: Lens' CodeConfigurationValues (Maybe Text) Source #

The command App Runner runs to build your application.

codeConfigurationValues_port :: Lens' CodeConfigurationValues (Maybe Text) Source #

The port that your application listens to in the container.

Default: 8080

codeConfigurationValues_runtimeEnvironmentSecrets :: Lens' CodeConfigurationValues (Maybe (HashMap Text Text)) Source #

An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

  • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
  • Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.

codeConfigurationValues_runtimeEnvironmentVariables :: Lens' CodeConfigurationValues (Maybe (HashMap Text Text)) Source #

The environment variables that are available to your running App Runner service. An array of key-value pairs.

codeConfigurationValues_startCommand :: Lens' CodeConfigurationValues (Maybe Text) Source #

The command App Runner runs to start your application.

codeConfigurationValues_runtime :: Lens' CodeConfigurationValues Runtime Source #

A runtime environment type for building and running an App Runner service. It represents a programming language runtime.

CodeRepository

codeRepository_codeConfiguration :: Lens' CodeRepository (Maybe CodeConfiguration) Source #

Configuration for building and running the service from a source code repository.

CodeConfiguration is required only for CreateService request.

codeRepository_repositoryUrl :: Lens' CodeRepository Text Source #

The location of the repository that contains the source code.

codeRepository_sourceCodeVersion :: Lens' CodeRepository SourceCodeVersion Source #

The version that should be used within the source code repository.

Connection

connection_connectionArn :: Lens' Connection (Maybe Text) Source #

The Amazon Resource Name (ARN) of this connection.

connection_connectionName :: Lens' Connection (Maybe Text) Source #

The customer-provided connection name.

connection_createdAt :: Lens' Connection (Maybe UTCTime) Source #

The App Runner connection creation time, expressed as a Unix time stamp.

connection_providerType :: Lens' Connection (Maybe ProviderType) Source #

The source repository provider.

connection_status :: Lens' Connection (Maybe ConnectionStatus) Source #

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an App Runner service.

ConnectionSummary

connectionSummary_connectionArn :: Lens' ConnectionSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of this connection.

connectionSummary_connectionName :: Lens' ConnectionSummary (Maybe Text) Source #

The customer-provided connection name.

connectionSummary_createdAt :: Lens' ConnectionSummary (Maybe UTCTime) Source #

The App Runner connection creation time, expressed as a Unix time stamp.

connectionSummary_status :: Lens' ConnectionSummary (Maybe ConnectionStatus) Source #

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an App Runner service.

CustomDomain

customDomain_certificateValidationRecords :: Lens' CustomDomain (Maybe [CertificateValidationRecord]) Source #

A list of certificate CNAME records that's used for this domain name.

customDomain_domainName :: Lens' CustomDomain Text Source #

An associated custom domain endpoint. It can be 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).

customDomain_enableWWWSubdomain :: Lens' CustomDomain Bool Source #

When true, the subdomain www.DomainName is associated with the App Runner service in addition to the base domain.

customDomain_status :: Lens' CustomDomain CustomDomainAssociationStatus Source #

The current state of the domain name association.

EgressConfiguration

egressConfiguration_egressType :: Lens' EgressConfiguration (Maybe EgressType) Source #

The type of egress configuration.

Set to DEFAULT for access to resources hosted on public networks.

Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.

egressConfiguration_vpcConnectorArn :: Lens' EgressConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.

EncryptionConfiguration

encryptionConfiguration_kmsKey :: Lens' EncryptionConfiguration Text Source #

The ARN of the KMS key that's used for encryption.

HealthCheckConfiguration

healthCheckConfiguration_healthyThreshold :: Lens' HealthCheckConfiguration (Maybe Natural) Source #

The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

Default: 1

healthCheckConfiguration_interval :: Lens' HealthCheckConfiguration (Maybe Natural) Source #

The time interval, in seconds, between health checks.

Default: 5

healthCheckConfiguration_path :: Lens' HealthCheckConfiguration (Maybe Text) Source #

The URL that health check requests are sent to.

Path is only applicable when you set Protocol to HTTP.

Default: "/"

healthCheckConfiguration_protocol :: Lens' HealthCheckConfiguration (Maybe HealthCheckProtocol) Source #

The IP protocol that App Runner uses to perform health checks for your service.

If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

Default: TCP

healthCheckConfiguration_timeout :: Lens' HealthCheckConfiguration (Maybe Natural) Source #

The time, in seconds, to wait for a health check response before deciding it failed.

Default: 2

healthCheckConfiguration_unhealthyThreshold :: Lens' HealthCheckConfiguration (Maybe Natural) Source #

The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

Default: 5

ImageConfiguration

imageConfiguration_port :: Lens' ImageConfiguration (Maybe Text) Source #

The port that your application listens to in the container.

Default: 8080

imageConfiguration_runtimeEnvironmentSecrets :: Lens' ImageConfiguration (Maybe (HashMap Text Text)) Source #

An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

  • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
  • Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.

imageConfiguration_runtimeEnvironmentVariables :: Lens' ImageConfiguration (Maybe (HashMap Text Text)) Source #

Environment variables that are available to your running App Runner service. An array of key-value pairs.

imageConfiguration_startCommand :: Lens' ImageConfiguration (Maybe Text) Source #

An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

ImageRepository

imageRepository_imageConfiguration :: Lens' ImageRepository (Maybe ImageConfiguration) Source #

Configuration for running the identified image.

imageRepository_imageIdentifier :: Lens' ImageRepository Text Source #

The identifier of an image.

For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see Pulling an image in the Amazon ECR User Guide.

imageRepository_imageRepositoryType :: Lens' ImageRepository ImageRepositoryType Source #

The type of the image repository. This reflects the repository provider and whether the repository is private or public.

IngressConfiguration

ingressConfiguration_isPubliclyAccessible :: Lens' IngressConfiguration (Maybe Bool) Source #

Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.

IngressVpcConfiguration

ingressVpcConfiguration_vpcEndpointId :: Lens' IngressVpcConfiguration (Maybe Text) Source #

The ID of the VPC endpoint that your App Runner service connects to.

ingressVpcConfiguration_vpcId :: Lens' IngressVpcConfiguration (Maybe Text) Source #

The ID of the VPC that is used for the VPC endpoint.

InstanceConfiguration

instanceConfiguration_cpu :: Lens' InstanceConfiguration (Maybe Text) Source #

The number of CPU units reserved for each instance of your App Runner service.

Default: 1 vCPU

instanceConfiguration_instanceRoleArn :: Lens' InstanceConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls any Amazon Web Services APIs.

instanceConfiguration_memory :: Lens' InstanceConfiguration (Maybe Text) Source #

The amount of memory, in MB or GB, reserved for each instance of your App Runner service.

Default: 2 GB

ListVpcIngressConnectionsFilter

listVpcIngressConnectionsFilter_serviceArn :: Lens' ListVpcIngressConnectionsFilter (Maybe Text) Source #

The Amazon Resource Name (ARN) of a service to filter by.

NetworkConfiguration

networkConfiguration_egressConfiguration :: Lens' NetworkConfiguration (Maybe EgressConfiguration) Source #

Network configuration settings for outbound message traffic.

networkConfiguration_ingressConfiguration :: Lens' NetworkConfiguration (Maybe IngressConfiguration) Source #

Network configuration settings for inbound message traffic.

ObservabilityConfiguration

observabilityConfiguration_createdAt :: Lens' ObservabilityConfiguration (Maybe UTCTime) Source #

The time when the observability configuration was created. It's in Unix time stamp format.

observabilityConfiguration_deletedAt :: Lens' ObservabilityConfiguration (Maybe UTCTime) Source #

The time when the observability configuration was deleted. It's in Unix time stamp format.

observabilityConfiguration_latest :: Lens' ObservabilityConfiguration (Maybe Bool) Source #

It's set to true for the configuration with the highest Revision among all configurations that share the same ObservabilityConfigurationName. It's set to false otherwise.

observabilityConfiguration_observabilityConfigurationArn :: Lens' ObservabilityConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of this observability configuration.

observabilityConfiguration_observabilityConfigurationName :: Lens' ObservabilityConfiguration (Maybe Text) Source #

The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.

observabilityConfiguration_observabilityConfigurationRevision :: Lens' ObservabilityConfiguration (Maybe Int) Source #

The revision of this observability configuration. It's unique among all the active configurations ("Status": "ACTIVE") that share the same ObservabilityConfigurationName.

observabilityConfiguration_status :: Lens' ObservabilityConfiguration (Maybe ObservabilityConfigurationStatus) Source #

The current state of the observability configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted.

observabilityConfiguration_traceConfiguration :: Lens' ObservabilityConfiguration (Maybe TraceConfiguration) Source #

The configuration of the tracing feature within this observability configuration. If not specified, tracing isn't enabled.

ObservabilityConfigurationSummary

observabilityConfigurationSummary_observabilityConfigurationArn :: Lens' ObservabilityConfigurationSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of this observability configuration.

observabilityConfigurationSummary_observabilityConfigurationName :: Lens' ObservabilityConfigurationSummary (Maybe Text) Source #

The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.

observabilityConfigurationSummary_observabilityConfigurationRevision :: Lens' ObservabilityConfigurationSummary (Maybe Int) Source #

The revision of this observability configuration. It's unique among all the active configurations ("Status": "ACTIVE") that share the same ObservabilityConfigurationName.

OperationSummary

operationSummary_endedAt :: Lens' OperationSummary (Maybe UTCTime) Source #

The time when the operation ended. It's in the Unix time stamp format.

operationSummary_id :: Lens' OperationSummary (Maybe Text) Source #

A unique ID of this operation. It's unique in the scope of the App Runner service.

operationSummary_startedAt :: Lens' OperationSummary (Maybe UTCTime) Source #

The time when the operation started. It's in the Unix time stamp format.

operationSummary_targetArn :: Lens' OperationSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource that the operation acted on (for example, an App Runner service).

operationSummary_type :: Lens' OperationSummary (Maybe OperationType) Source #

The type of operation. It indicates a specific action that occured.

operationSummary_updatedAt :: Lens' OperationSummary (Maybe UTCTime) Source #

The time when the operation was last updated. It's in the Unix time stamp format.

Service

service_deletedAt :: Lens' Service (Maybe UTCTime) Source #

The time when the App Runner service was deleted. It's in the Unix time stamp format.

service_encryptionConfiguration :: Lens' Service (Maybe EncryptionConfiguration) Source #

The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that App Runner maintains for the service. It can be either a customer-provided encryption key or an Amazon Web Services managed key.

service_healthCheckConfiguration :: Lens' Service (Maybe HealthCheckConfiguration) Source #

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

service_serviceUrl :: Lens' Service (Maybe Text) Source #

A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

service_serviceName :: Lens' Service Text Source #

The customer-provided service name.

service_serviceId :: Lens' Service Text Source #

An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.

service_serviceArn :: Lens' Service Text Source #

The Amazon Resource Name (ARN) of this service.

service_createdAt :: Lens' Service UTCTime Source #

The time when the App Runner service was created. It's in the Unix time stamp format.

service_updatedAt :: Lens' Service UTCTime Source #

The time when the App Runner service was last updated at. It's in the Unix time stamp format.

service_status :: Lens' Service ServiceStatus Source #

The current state of the App Runner service. These particular values mean the following.

  • CREATE_FAILED – The service failed to create. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service.

    The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.

  • DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

service_sourceConfiguration :: Lens' Service SourceConfiguration Source #

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

service_instanceConfiguration :: Lens' Service InstanceConfiguration Source #

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

service_autoScalingConfigurationSummary :: Lens' Service AutoScalingConfigurationSummary Source #

Summary information for the App Runner automatic scaling configuration resource that's associated with this service.

service_networkConfiguration :: Lens' Service NetworkConfiguration Source #

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

ServiceObservabilityConfiguration

serviceObservabilityConfiguration_observabilityConfigurationArn :: Lens' ServiceObservabilityConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.

Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3

Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing

serviceObservabilityConfiguration_observabilityEnabled :: Lens' ServiceObservabilityConfiguration Bool Source #

When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.

ServiceSummary

serviceSummary_createdAt :: Lens' ServiceSummary (Maybe UTCTime) Source #

The time when the App Runner service was created. It's in the Unix time stamp format.

serviceSummary_serviceArn :: Lens' ServiceSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of this service.

serviceSummary_serviceId :: Lens' ServiceSummary (Maybe Text) Source #

An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.

serviceSummary_serviceName :: Lens' ServiceSummary (Maybe Text) Source #

The customer-provided service name.

serviceSummary_serviceUrl :: Lens' ServiceSummary (Maybe Text) Source #

A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

serviceSummary_status :: Lens' ServiceSummary (Maybe ServiceStatus) Source #

The current state of the App Runner service. These particular values mean the following.

  • CREATE_FAILED – The service failed to create. Read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service.

    The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.

  • DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

serviceSummary_updatedAt :: Lens' ServiceSummary (Maybe UTCTime) Source #

The time when the App Runner service was last updated. It's in theUnix time stamp format.

SourceCodeVersion

sourceCodeVersion_type :: Lens' SourceCodeVersion SourceCodeVersionType Source #

The type of version identifier.

For a git-based repository, branches represent versions.

sourceCodeVersion_value :: Lens' SourceCodeVersion Text Source #

A source code version.

For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.

SourceConfiguration

sourceConfiguration_authenticationConfiguration :: Lens' SourceConfiguration (Maybe AuthenticationConfiguration) Source #

Describes the resources that are needed to authenticate access to some source repositories.

sourceConfiguration_autoDeploymentsEnabled :: Lens' SourceConfiguration (Maybe Bool) Source #

If true, continuous integration from the source repository is enabled for the App Runner service. Each repository change (including any source code commit or new image version) starts a deployment.

Default: App Runner sets to false for a source image that uses an ECR Public repository or an ECR repository that's in an Amazon Web Services account other than the one that the service is in. App Runner sets to true in all other cases (which currently include a source code repository or a source image using a same-account ECR repository).

sourceConfiguration_codeRepository :: Lens' SourceConfiguration (Maybe CodeRepository) Source #

The description of a source code repository.

You must provide either this member or ImageRepository (but not both).

sourceConfiguration_imageRepository :: Lens' SourceConfiguration (Maybe ImageRepository) Source #

The description of a source image repository.

You must provide either this member or CodeRepository (but not both).

Tag

tag_key :: Lens' Tag (Maybe Text) Source #

The key of the tag.

tag_value :: Lens' Tag (Maybe Text) Source #

The value of the tag.

TraceConfiguration

traceConfiguration_vendor :: Lens' TraceConfiguration TracingVendor Source #

The implementation provider chosen for tracing App Runner services.

VpcConnector

vpcConnector_createdAt :: Lens' VpcConnector (Maybe UTCTime) Source #

The time when the VPC connector was created. It's in Unix time stamp format.

vpcConnector_deletedAt :: Lens' VpcConnector (Maybe UTCTime) Source #

The time when the VPC connector was deleted. It's in Unix time stamp format.

vpcConnector_securityGroups :: Lens' VpcConnector (Maybe [Text]) Source #

A list of IDs of security groups that App Runner uses 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.

vpcConnector_status :: Lens' VpcConnector (Maybe VpcConnectorStatus) Source #

The current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

vpcConnector_subnets :: Lens' VpcConnector (Maybe [Text]) Source #

A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.

vpcConnector_vpcConnectorArn :: Lens' VpcConnector (Maybe Text) Source #

The Amazon Resource Name (ARN) of this VPC connector.

vpcConnector_vpcConnectorName :: Lens' VpcConnector (Maybe Text) Source #

The customer-provided VPC connector name.

vpcConnector_vpcConnectorRevision :: Lens' VpcConnector (Maybe Int) Source #

The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

At this time, App Runner supports only one revision per name.

VpcDNSTarget

vpcDNSTarget_domainName :: Lens' VpcDNSTarget (Maybe Text) Source #

The domain name of your target DNS that is associated with the Amazon VPC.

vpcDNSTarget_vpcId :: Lens' VpcDNSTarget (Maybe Text) Source #

The ID of the Amazon VPC that is associated with the custom domain name of the target DNS.

vpcDNSTarget_vpcIngressConnectionArn :: Lens' VpcDNSTarget (Maybe Text) Source #

The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated with your service.

VpcIngressConnection

vpcIngressConnection_accountId :: Lens' VpcIngressConnection (Maybe Text) Source #

The Account Id you use to create the VPC Ingress Connection resource.

vpcIngressConnection_createdAt :: Lens' VpcIngressConnection (Maybe UTCTime) Source #

The time when the VPC Ingress Connection was created. It's in the Unix time stamp format.

  • Type: Timestamp
  • Required: Yes

vpcIngressConnection_deletedAt :: Lens' VpcIngressConnection (Maybe UTCTime) Source #

The time when the App Runner service was deleted. It's in the Unix time stamp format.

  • Type: Timestamp
  • Required: No

vpcIngressConnection_domainName :: Lens' VpcIngressConnection (Maybe Text) Source #

The domain name associated with the VPC Ingress Connection resource.

vpcIngressConnection_ingressVpcConfiguration :: Lens' VpcIngressConnection (Maybe IngressVpcConfiguration) Source #

Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.

vpcIngressConnection_serviceArn :: Lens' VpcIngressConnection (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.

vpcIngressConnection_status :: Lens' VpcIngressConnection (Maybe VpcIngressConnectionStatus) Source #

The current status of the VPC Ingress Connection. The VPC Ingress Connection displays one of the following statuses: AVAILABLE, PENDING_CREATION, PENDING_UPDATE, PENDING_DELETION,FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, and DELETED..

vpcIngressConnection_vpcIngressConnectionArn :: Lens' VpcIngressConnection (Maybe Text) Source #

The Amazon Resource Name (ARN) of the VPC Ingress Connection.

vpcIngressConnection_vpcIngressConnectionName :: Lens' VpcIngressConnection (Maybe Text) Source #

The customer-provided VPC Ingress Connection name.

VpcIngressConnectionSummary

vpcIngressConnectionSummary_serviceArn :: Lens' VpcIngressConnectionSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.

vpcIngressConnectionSummary_vpcIngressConnectionArn :: Lens' VpcIngressConnectionSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the VPC Ingress Connection.