AWS App Runner

{'NetworkConfiguration': {'IpAddressType': 'IPV4 | DUAL_STACK'}}

{'Service': {'NetworkConfiguration': {'IpAddressType': 'IPV4 | DUAL_STACK'}}}

Create an App Runner service. After the service is created, the action also automatically starts a deployment.

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

See also: AWS API Documentation

Request Syntax

client.create_service(
    ServiceName='string',
    SourceConfiguration={
        'CodeRepository': {
            'RepositoryUrl': 'string',
            'SourceCodeVersion': {
                'Type': 'BRANCH',
                'Value': 'string'
            },
            'CodeConfiguration': {
                'ConfigurationSource': 'REPOSITORY'|'API',
                'CodeConfigurationValues': {
                    'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
                    'BuildCommand': 'string',
                    'StartCommand': 'string',
                    'Port': 'string',
                    'RuntimeEnvironmentVariables': {
                        'string': 'string'
                    },
                    'RuntimeEnvironmentSecrets': {
                        'string': 'string'
                    }
                }
            },
            'SourceDirectory': 'string'
        },
        'ImageRepository': {
            'ImageIdentifier': 'string',
            'ImageConfiguration': {
                'RuntimeEnvironmentVariables': {
                    'string': 'string'
                },
                'StartCommand': 'string',
                'Port': 'string',
                'RuntimeEnvironmentSecrets': {
                    'string': 'string'
                }
            },
            'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
        },
        'AutoDeploymentsEnabled': True|False,
        'AuthenticationConfiguration': {
            'ConnectionArn': 'string',
            'AccessRoleArn': 'string'
        }
    },
    InstanceConfiguration={
        'Cpu': 'string',
        'Memory': 'string',
        'InstanceRoleArn': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    EncryptionConfiguration={
        'KmsKey': 'string'
    },
    HealthCheckConfiguration={
        'Protocol': 'TCP'|'HTTP',
        'Path': 'string',
        'Interval': 123,
        'Timeout': 123,
        'HealthyThreshold': 123,
        'UnhealthyThreshold': 123
    },
    AutoScalingConfigurationArn='string',
    NetworkConfiguration={
        'EgressConfiguration': {
            'EgressType': 'DEFAULT'|'VPC',
            'VpcConnectorArn': 'string'
        },
        'IngressConfiguration': {
            'IsPubliclyAccessible': True|False
        },
        'IpAddressType': 'IPV4'|'DUAL_STACK'
    },
    ObservabilityConfiguration={
        'ObservabilityEnabled': True|False,
        'ObservabilityConfigurationArn': 'string'
    }
)

type ServiceName:

string

param ServiceName:

[REQUIRED]

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.

type SourceConfiguration:

dict

param SourceConfiguration:

[REQUIRED]

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

• CodeRepository (dict) --

  The description of a source code repository.

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

  • RepositoryUrl (string) -- [REQUIRED]

    The location of the repository that contains the source code.

  • SourceCodeVersion (dict) -- [REQUIRED]

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

    • Type (string) -- [REQUIRED]

      The type of version identifier.

      For a git-based repository, branches represent versions.

    • Value (string) -- [REQUIRED]

      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.

  • CodeConfiguration (dict) --

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

    • ConfigurationSource (string) -- [REQUIRED]

      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 (dict) --

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

      • Runtime (string) -- [REQUIRED]

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

      • BuildCommand (string) --

        The command App Runner runs to build your application.

      • StartCommand (string) --

        The command App Runner runs to start your application.

      • Port (string) --

        The port that your application listens to in the container.

        Default: 8080

      • RuntimeEnvironmentVariables (dict) --

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

        • (string) --

          • (string) --

      • RuntimeEnvironmentSecrets (dict) --

        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.

        • (string) --

          • (string) --

  • SourceDirectory (string) --

    The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.

• ImageRepository (dict) --

  The description of a source image repository.

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

  • ImageIdentifier (string) -- [REQUIRED]

    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.

  • ImageConfiguration (dict) --

    Configuration for running the identified image.

    • RuntimeEnvironmentVariables (dict) --

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

      • (string) --

        • (string) --

    • StartCommand (string) --

      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.

    • Port (string) --

      The port that your application listens to in the container.

      Default: 8080

    • RuntimeEnvironmentSecrets (dict) --

      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.

      • (string) --

        • (string) --

  • ImageRepositoryType (string) -- [REQUIRED]

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

• AutoDeploymentsEnabled (boolean) --

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

• AuthenticationConfiguration (dict) --

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

  • ConnectionArn (string) --

    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.

  • AccessRoleArn (string) --

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

type InstanceConfiguration:

dict

param InstanceConfiguration:

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

• Cpu (string) --

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

  Default: 1 vCPU

• Memory (string) --

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

  Default: 2 GB

• InstanceRoleArn (string) --

  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.

type Tags:

list

param Tags:

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

• (dict) --

  Describes a tag that is applied to an App Runner resource. A tag is a metadata item consisting of a key-value pair.

  • Key (string) --

    The key of the tag.

  • Value (string) --

    The value of the tag.

type EncryptionConfiguration:

dict

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

• KmsKey (string) -- [REQUIRED]

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

type HealthCheckConfiguration:

dict

param HealthCheckConfiguration:

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

• Protocol (string) --

  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

• Path (string) --

  The URL that health check requests are sent to.

  Path is only applicable when you set Protocol to HTTP.

  Default: "/"

• Interval (integer) --

  The time interval, in seconds, between health checks.

  Default: 5

• Timeout (integer) --

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

  Default: 2

• HealthyThreshold (integer) --

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

  Default: 1

• UnhealthyThreshold (integer) --

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

  Default: 5

type AutoScalingConfigurationArn:

string

param AutoScalingConfigurationArn:

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

type NetworkConfiguration:

dict

param NetworkConfiguration:

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

• EgressConfiguration (dict) --

  Network configuration settings for outbound message traffic.

  • EgressType (string) --

    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.

  • VpcConnectorArn (string) --

    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.

• IngressConfiguration (dict) --

  Network configuration settings for inbound message traffic.

  • IsPubliclyAccessible (boolean) --

    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.

• IpAddressType (string) --

  App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual-stack (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you do not specify an IpAddressType, it defaults to select IPv4.

type ObservabilityConfiguration:

dict

param ObservabilityConfiguration:

The observability configuration of your service.

• ObservabilityEnabled (boolean) -- [REQUIRED]

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

• ObservabilityConfigurationArn (string) --

  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

rtype:

dict

returns:

Response Syntax

{
    'Service': {
        'ServiceName': 'string',
        'ServiceId': 'string',
        'ServiceArn': 'string',
        'ServiceUrl': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'DeletedAt': datetime(2015, 1, 1),
        'Status': 'CREATE_FAILED'|'RUNNING'|'DELETED'|'DELETE_FAILED'|'PAUSED'|'OPERATION_IN_PROGRESS',
        'SourceConfiguration': {
            'CodeRepository': {
                'RepositoryUrl': 'string',
                'SourceCodeVersion': {
                    'Type': 'BRANCH',
                    'Value': 'string'
                },
                'CodeConfiguration': {
                    'ConfigurationSource': 'REPOSITORY'|'API',
                    'CodeConfigurationValues': {
                        'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
                        'BuildCommand': 'string',
                        'StartCommand': 'string',
                        'Port': 'string',
                        'RuntimeEnvironmentVariables': {
                            'string': 'string'
                        },
                        'RuntimeEnvironmentSecrets': {
                            'string': 'string'
                        }
                    }
                },
                'SourceDirectory': 'string'
            },
            'ImageRepository': {
                'ImageIdentifier': 'string',
                'ImageConfiguration': {
                    'RuntimeEnvironmentVariables': {
                        'string': 'string'
                    },
                    'StartCommand': 'string',
                    'Port': 'string',
                    'RuntimeEnvironmentSecrets': {
                        'string': 'string'
                    }
                },
                'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
            },
            'AutoDeploymentsEnabled': True|False,
            'AuthenticationConfiguration': {
                'ConnectionArn': 'string',
                'AccessRoleArn': 'string'
            }
        },
        'InstanceConfiguration': {
            'Cpu': 'string',
            'Memory': 'string',
            'InstanceRoleArn': 'string'
        },
        'EncryptionConfiguration': {
            'KmsKey': 'string'
        },
        'HealthCheckConfiguration': {
            'Protocol': 'TCP'|'HTTP',
            'Path': 'string',
            'Interval': 123,
            'Timeout': 123,
            'HealthyThreshold': 123,
            'UnhealthyThreshold': 123
        },
        'AutoScalingConfigurationSummary': {
            'AutoScalingConfigurationArn': 'string',
            'AutoScalingConfigurationName': 'string',
            'AutoScalingConfigurationRevision': 123,
            'Status': 'ACTIVE'|'INACTIVE',
            'CreatedAt': datetime(2015, 1, 1),
            'HasAssociatedService': True|False,
            'IsDefault': True|False
        },
        'NetworkConfiguration': {
            'EgressConfiguration': {
                'EgressType': 'DEFAULT'|'VPC',
                'VpcConnectorArn': 'string'
            },
            'IngressConfiguration': {
                'IsPubliclyAccessible': True|False
            },
            'IpAddressType': 'IPV4'|'DUAL_STACK'
        },
        'ObservabilityConfiguration': {
            'ObservabilityEnabled': True|False,
            'ObservabilityConfigurationArn': 'string'
        }
    },
    'OperationId': 'string'
}

Response Structure

• (dict) --

  • Service (dict) --

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

    • ServiceName (string) --

      The customer-provided service name.

    • ServiceId (string) --

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

    • ServiceArn (string) --

      The Amazon Resource Name (ARN) of this service.

    • ServiceUrl (string) --

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

    • CreatedAt (datetime) --

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

    • UpdatedAt (datetime) --

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

    • DeletedAt (datetime) --

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

    • Status (string) --

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

      • CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

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

    • SourceConfiguration (dict) --

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

      • CodeRepository (dict) --

        The description of a source code repository.

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

        • RepositoryUrl (string) --

          The location of the repository that contains the source code.

        • SourceCodeVersion (dict) --

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

          • Type (string) --

            The type of version identifier.

            For a git-based repository, branches represent versions.

          • Value (string) --

            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.

        • CodeConfiguration (dict) --

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

          • ConfigurationSource (string) --

            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 (dict) --

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

            • Runtime (string) --

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

            • BuildCommand (string) --

              The command App Runner runs to build your application.

            • StartCommand (string) --

              The command App Runner runs to start your application.

            • Port (string) --

              The port that your application listens to in the container.

              Default: 8080

            • RuntimeEnvironmentVariables (dict) --

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

              • (string) --

                • (string) --

            • RuntimeEnvironmentSecrets (dict) --

              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.

              • (string) --

                • (string) --

        • SourceDirectory (string) --

          The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.

      • ImageRepository (dict) --

        The description of a source image repository.

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

        • ImageIdentifier (string) --

          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.

        • ImageConfiguration (dict) --

          Configuration for running the identified image.

          • RuntimeEnvironmentVariables (dict) --

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

            • (string) --

              • (string) --

          • StartCommand (string) --

            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.

          • Port (string) --

            The port that your application listens to in the container.

            Default: 8080

          • RuntimeEnvironmentSecrets (dict) --

            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.

            • (string) --

              • (string) --

        • ImageRepositoryType (string) --

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

      • AutoDeploymentsEnabled (boolean) --

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

      • AuthenticationConfiguration (dict) --

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

        • ConnectionArn (string) --

          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.

        • AccessRoleArn (string) --

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

    • InstanceConfiguration (dict) --

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

      • Cpu (string) --

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

        Default: 1 vCPU

      • Memory (string) --

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

        Default: 2 GB

      • InstanceRoleArn (string) --

        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.

    • EncryptionConfiguration (dict) --

      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.

      • KmsKey (string) --

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

    • HealthCheckConfiguration (dict) --

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

      • Protocol (string) --

        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

      • Path (string) --

        The URL that health check requests are sent to.

        Path is only applicable when you set Protocol to HTTP.

        Default: "/"

      • Interval (integer) --

        The time interval, in seconds, between health checks.

        Default: 5

      • Timeout (integer) --

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

        Default: 2

      • HealthyThreshold (integer) --

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

        Default: 1

      • UnhealthyThreshold (integer) --

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

        Default: 5

    • AutoScalingConfigurationSummary (dict) --

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

      • AutoScalingConfigurationArn (string) --

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

      • AutoScalingConfigurationName (string) --

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

      • AutoScalingConfigurationRevision (integer) --

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

      • Status (string) --

        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.

      • CreatedAt (datetime) --

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

      • HasAssociatedService (boolean) --

        Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

      • IsDefault (boolean) --

        Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under the same AutoScalingConfigurationName.

    • NetworkConfiguration (dict) --

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

      • EgressConfiguration (dict) --

        Network configuration settings for outbound message traffic.

        • EgressType (string) --

          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.

        • VpcConnectorArn (string) --

          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.

      • IngressConfiguration (dict) --

        Network configuration settings for inbound message traffic.

        • IsPubliclyAccessible (boolean) --

          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.

      • IpAddressType (string) --

        App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual-stack (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you do not specify an IpAddressType, it defaults to select IPv4.

    • ObservabilityConfiguration (dict) --

      The observability configuration of this service.

      • ObservabilityEnabled (boolean) --

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

      • ObservabilityConfigurationArn (string) --

        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

  • OperationId (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.

{'Service': {'NetworkConfiguration': {'IpAddressType': 'IPV4 | DUAL_STACK'}}}

Delete an App Runner service.

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

See also: AWS API Documentation

Request Syntax

client.delete_service(
    ServiceArn='string'
)

type ServiceArn:

string

param ServiceArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'Service': {
        'ServiceName': 'string',
        'ServiceId': 'string',
        'ServiceArn': 'string',
        'ServiceUrl': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'DeletedAt': datetime(2015, 1, 1),
        'Status': 'CREATE_FAILED'|'RUNNING'|'DELETED'|'DELETE_FAILED'|'PAUSED'|'OPERATION_IN_PROGRESS',
        'SourceConfiguration': {
            'CodeRepository': {
                'RepositoryUrl': 'string',
                'SourceCodeVersion': {
                    'Type': 'BRANCH',
                    'Value': 'string'
                },
                'CodeConfiguration': {
                    'ConfigurationSource': 'REPOSITORY'|'API',
                    'CodeConfigurationValues': {
                        'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
                        'BuildCommand': 'string',
                        'StartCommand': 'string',
                        'Port': 'string',
                        'RuntimeEnvironmentVariables': {
                            'string': 'string'
                        },
                        'RuntimeEnvironmentSecrets': {
                            'string': 'string'
                        }
                    }
                },
                'SourceDirectory': 'string'
            },
            'ImageRepository': {
                'ImageIdentifier': 'string',
                'ImageConfiguration': {
                    'RuntimeEnvironmentVariables': {
                        'string': 'string'
                    },
                    'StartCommand': 'string',
                    'Port': 'string',
                    'RuntimeEnvironmentSecrets': {
                        'string': 'string'
                    }
                },
                'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
            },
            'AutoDeploymentsEnabled': True|False,
            'AuthenticationConfiguration': {
                'ConnectionArn': 'string',
                'AccessRoleArn': 'string'
            }
        },
        'InstanceConfiguration': {
            'Cpu': 'string',
            'Memory': 'string',
            'InstanceRoleArn': 'string'
        },
        'EncryptionConfiguration': {
            'KmsKey': 'string'
        },
        'HealthCheckConfiguration': {
            'Protocol': 'TCP'|'HTTP',
            'Path': 'string',
            'Interval': 123,
            'Timeout': 123,
            'HealthyThreshold': 123,
            'UnhealthyThreshold': 123
        },
        'AutoScalingConfigurationSummary': {
            'AutoScalingConfigurationArn': 'string',
            'AutoScalingConfigurationName': 'string',
            'AutoScalingConfigurationRevision': 123,
            'Status': 'ACTIVE'|'INACTIVE',
            'CreatedAt': datetime(2015, 1, 1),
            'HasAssociatedService': True|False,
            'IsDefault': True|False
        },
        'NetworkConfiguration': {
            'EgressConfiguration': {
                'EgressType': 'DEFAULT'|'VPC',
                'VpcConnectorArn': 'string'
            },
            'IngressConfiguration': {
                'IsPubliclyAccessible': True|False
            },
            'IpAddressType': 'IPV4'|'DUAL_STACK'
        },
        'ObservabilityConfiguration': {
            'ObservabilityEnabled': True|False,
            'ObservabilityConfigurationArn': 'string'
        }
    },
    'OperationId': 'string'
}

Response Structure

• (dict) --

  • Service (dict) --

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

    • ServiceName (string) --

      The customer-provided service name.

    • ServiceId (string) --

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

    • ServiceArn (string) --

      The Amazon Resource Name (ARN) of this service.

    • ServiceUrl (string) --

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

    • CreatedAt (datetime) --

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

    • UpdatedAt (datetime) --

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

    • DeletedAt (datetime) --

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

    • Status (string) --

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

      • CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

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

    • SourceConfiguration (dict) --

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

      • CodeRepository (dict) --

        The description of a source code repository.

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

        • RepositoryUrl (string) --

          The location of the repository that contains the source code.

        • SourceCodeVersion (dict) --

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

          • Type (string) --

            The type of version identifier.

            For a git-based repository, branches represent versions.

          • Value (string) --

            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.

        • CodeConfiguration (dict) --

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

          • ConfigurationSource (string) --

            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 (dict) --

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

            • Runtime (string) --

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

            • BuildCommand (string) --

              The command App Runner runs to build your application.

            • StartCommand (string) --

              The command App Runner runs to start your application.

            • Port (string) --

              The port that your application listens to in the container.

              Default: 8080

            • RuntimeEnvironmentVariables (dict) --

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

              • (string) --

                • (string) --

            • RuntimeEnvironmentSecrets (dict) --

              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.

              • (string) --

                • (string) --

        • SourceDirectory (string) --

          The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.

      • ImageRepository (dict) --

        The description of a source image repository.

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

        • ImageIdentifier (string) --

          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.

        • ImageConfiguration (dict) --

          Configuration for running the identified image.

          • RuntimeEnvironmentVariables (dict) --

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

            • (string) --

              • (string) --

          • StartCommand (string) --

            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.

          • Port (string) --

            The port that your application listens to in the container.

            Default: 8080

          • RuntimeEnvironmentSecrets (dict) --

            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.

            • (string) --

              • (string) --

        • ImageRepositoryType (string) --

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

      • AutoDeploymentsEnabled (boolean) --

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

      • AuthenticationConfiguration (dict) --

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

        • ConnectionArn (string) --

          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.

        • AccessRoleArn (string) --

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

    • InstanceConfiguration (dict) --

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

      • Cpu (string) --

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

        Default: 1 vCPU

      • Memory (string) --

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

        Default: 2 GB

      • InstanceRoleArn (string) --

        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.

    • EncryptionConfiguration (dict) --

      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.

      • KmsKey (string) --

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

    • HealthCheckConfiguration (dict) --

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

      • Protocol (string) --

        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

      • Path (string) --

        The URL that health check requests are sent to.

        Path is only applicable when you set Protocol to HTTP.

        Default: "/"

      • Interval (integer) --

        The time interval, in seconds, between health checks.

        Default: 5

      • Timeout (integer) --

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

        Default: 2

      • HealthyThreshold (integer) --

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

        Default: 1

      • UnhealthyThreshold (integer) --

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

        Default: 5

    • AutoScalingConfigurationSummary (dict) --

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

      • AutoScalingConfigurationArn (string) --

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

      • AutoScalingConfigurationName (string) --

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

      • AutoScalingConfigurationRevision (integer) --

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

      • Status (string) --

        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.

      • CreatedAt (datetime) --

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

      • HasAssociatedService (boolean) --

        Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

      • IsDefault (boolean) --

        Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under the same AutoScalingConfigurationName.

    • NetworkConfiguration (dict) --

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

      • EgressConfiguration (dict) --

        Network configuration settings for outbound message traffic.

        • EgressType (string) --

          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.

        • VpcConnectorArn (string) --

          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.

      • IngressConfiguration (dict) --

        Network configuration settings for inbound message traffic.

        • IsPubliclyAccessible (boolean) --

          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.

      • IpAddressType (string) --

        App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual-stack (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you do not specify an IpAddressType, it defaults to select IPv4.

    • ObservabilityConfiguration (dict) --

      The observability configuration of this service.

      • ObservabilityEnabled (boolean) --

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

      • ObservabilityConfigurationArn (string) --

        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

  • OperationId (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.

{'Service': {'NetworkConfiguration': {'IpAddressType': 'IPV4 | DUAL_STACK'}}}

Return a full description of an App Runner service.

See also: AWS API Documentation

Request Syntax

client.describe_service(
    ServiceArn='string'
)

type ServiceArn:

string

param ServiceArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'Service': {
        'ServiceName': 'string',
        'ServiceId': 'string',
        'ServiceArn': 'string',
        'ServiceUrl': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'DeletedAt': datetime(2015, 1, 1),
        'Status': 'CREATE_FAILED'|'RUNNING'|'DELETED'|'DELETE_FAILED'|'PAUSED'|'OPERATION_IN_PROGRESS',
        'SourceConfiguration': {
            'CodeRepository': {
                'RepositoryUrl': 'string',
                'SourceCodeVersion': {
                    'Type': 'BRANCH',
                    'Value': 'string'
                },
                'CodeConfiguration': {
                    'ConfigurationSource': 'REPOSITORY'|'API',
                    'CodeConfigurationValues': {
                        'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
                        'BuildCommand': 'string',
                        'StartCommand': 'string',
                        'Port': 'string',
                        'RuntimeEnvironmentVariables': {
                            'string': 'string'
                        },
                        'RuntimeEnvironmentSecrets': {
                            'string': 'string'
                        }
                    }
                },
                'SourceDirectory': 'string'
            },
            'ImageRepository': {
                'ImageIdentifier': 'string',
                'ImageConfiguration': {
                    'RuntimeEnvironmentVariables': {
                        'string': 'string'
                    },
                    'StartCommand': 'string',
                    'Port': 'string',
                    'RuntimeEnvironmentSecrets': {
                        'string': 'string'
                    }
                },
                'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
            },
            'AutoDeploymentsEnabled': True|False,
            'AuthenticationConfiguration': {
                'ConnectionArn': 'string',
                'AccessRoleArn': 'string'
            }
        },
        'InstanceConfiguration': {
            'Cpu': 'string',
            'Memory': 'string',
            'InstanceRoleArn': 'string'
        },
        'EncryptionConfiguration': {
            'KmsKey': 'string'
        },
        'HealthCheckConfiguration': {
            'Protocol': 'TCP'|'HTTP',
            'Path': 'string',
            'Interval': 123,
            'Timeout': 123,
            'HealthyThreshold': 123,
            'UnhealthyThreshold': 123
        },
        'AutoScalingConfigurationSummary': {
            'AutoScalingConfigurationArn': 'string',
            'AutoScalingConfigurationName': 'string',
            'AutoScalingConfigurationRevision': 123,
            'Status': 'ACTIVE'|'INACTIVE',
            'CreatedAt': datetime(2015, 1, 1),
            'HasAssociatedService': True|False,
            'IsDefault': True|False
        },
        'NetworkConfiguration': {
            'EgressConfiguration': {
                'EgressType': 'DEFAULT'|'VPC',
                'VpcConnectorArn': 'string'
            },
            'IngressConfiguration': {
                'IsPubliclyAccessible': True|False
            },
            'IpAddressType': 'IPV4'|'DUAL_STACK'
        },
        'ObservabilityConfiguration': {
            'ObservabilityEnabled': True|False,
            'ObservabilityConfigurationArn': 'string'
        }
    }
}

Response Structure

• (dict) --

  • Service (dict) --

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

    • ServiceName (string) --

      The customer-provided service name.

    • ServiceId (string) --

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

    • ServiceArn (string) --

      The Amazon Resource Name (ARN) of this service.

    • ServiceUrl (string) --

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

    • CreatedAt (datetime) --

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

    • UpdatedAt (datetime) --

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

    • DeletedAt (datetime) --

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

    • Status (string) --

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

      • CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

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

    • SourceConfiguration (dict) --

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

      • CodeRepository (dict) --

        The description of a source code repository.

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

        • RepositoryUrl (string) --

          The location of the repository that contains the source code.

        • SourceCodeVersion (dict) --

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

          • Type (string) --

            The type of version identifier.

            For a git-based repository, branches represent versions.

          • Value (string) --

            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.

        • CodeConfiguration (dict) --

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

          • ConfigurationSource (string) --

            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 (dict) --

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

            • Runtime (string) --

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

            • BuildCommand (string) --

              The command App Runner runs to build your application.

            • StartCommand (string) --

              The command App Runner runs to start your application.

            • Port (string) --

              The port that your application listens to in the container.

              Default: 8080

            • RuntimeEnvironmentVariables (dict) --

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

              • (string) --

                • (string) --

            • RuntimeEnvironmentSecrets (dict) --

              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.

              • (string) --

                • (string) --

        • SourceDirectory (string) --

          The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.

      • ImageRepository (dict) --

        The description of a source image repository.

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

        • ImageIdentifier (string) --

          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.

        • ImageConfiguration (dict) --

          Configuration for running the identified image.

          • RuntimeEnvironmentVariables (dict) --

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

            • (string) --

              • (string) --

          • StartCommand (string) --

            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.

          • Port (string) --

            The port that your application listens to in the container.

            Default: 8080

          • RuntimeEnvironmentSecrets (dict) --

            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.

            • (string) --

              • (string) --

        • ImageRepositoryType (string) --

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

      • AutoDeploymentsEnabled (boolean) --

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

      • AuthenticationConfiguration (dict) --

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

        • ConnectionArn (string) --

          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.

        • AccessRoleArn (string) --

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

    • InstanceConfiguration (dict) --

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

      • Cpu (string) --

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

        Default: 1 vCPU

      • Memory (string) --

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

        Default: 2 GB

      • InstanceRoleArn (string) --

        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.

    • EncryptionConfiguration (dict) --

      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.

      • KmsKey (string) --

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

    • HealthCheckConfiguration (dict) --

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

      • Protocol (string) --

        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

      • Path (string) --

        The URL that health check requests are sent to.

        Path is only applicable when you set Protocol to HTTP.

        Default: "/"

      • Interval (integer) --

        The time interval, in seconds, between health checks.

        Default: 5

      • Timeout (integer) --

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

        Default: 2

      • HealthyThreshold (integer) --

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

        Default: 1

      • UnhealthyThreshold (integer) --

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

        Default: 5

    • AutoScalingConfigurationSummary (dict) --

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

      • AutoScalingConfigurationArn (string) --

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

      • AutoScalingConfigurationName (string) --

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

      • AutoScalingConfigurationRevision (integer) --

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

      • Status (string) --

        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.

      • CreatedAt (datetime) --

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

      • HasAssociatedService (boolean) --

        Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

      • IsDefault (boolean) --

        Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under the same AutoScalingConfigurationName.

    • NetworkConfiguration (dict) --

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

      • EgressConfiguration (dict) --

        Network configuration settings for outbound message traffic.

        • EgressType (string) --

          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.

        • VpcConnectorArn (string) --

          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.

      • IngressConfiguration (dict) --

        Network configuration settings for inbound message traffic.

        • IsPubliclyAccessible (boolean) --

          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.

      • IpAddressType (string) --

        App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual-stack (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you do not specify an IpAddressType, it defaults to select IPv4.

    • ObservabilityConfiguration (dict) --

      The observability configuration of this service.

      • ObservabilityEnabled (boolean) --

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

      • ObservabilityConfigurationArn (string) --

        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

{'Service': {'NetworkConfiguration': {'IpAddressType': 'IPV4 | DUAL_STACK'}}}

Pause an active App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is removed).

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

See also: AWS API Documentation

Request Syntax

client.pause_service(
    ServiceArn='string'
)

type ServiceArn:

string

param ServiceArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'Service': {
        'ServiceName': 'string',
        'ServiceId': 'string',
        'ServiceArn': 'string',
        'ServiceUrl': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'DeletedAt': datetime(2015, 1, 1),
        'Status': 'CREATE_FAILED'|'RUNNING'|'DELETED'|'DELETE_FAILED'|'PAUSED'|'OPERATION_IN_PROGRESS',
        'SourceConfiguration': {
            'CodeRepository': {
                'RepositoryUrl': 'string',
                'SourceCodeVersion': {
                    'Type': 'BRANCH',
                    'Value': 'string'
                },
                'CodeConfiguration': {
                    'ConfigurationSource': 'REPOSITORY'|'API',
                    'CodeConfigurationValues': {
                        'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
                        'BuildCommand': 'string',
                        'StartCommand': 'string',
                        'Port': 'string',
                        'RuntimeEnvironmentVariables': {
                            'string': 'string'
                        },
                        'RuntimeEnvironmentSecrets': {
                            'string': 'string'
                        }
                    }
                },
                'SourceDirectory': 'string'
            },
            'ImageRepository': {
                'ImageIdentifier': 'string',
                'ImageConfiguration': {
                    'RuntimeEnvironmentVariables': {
                        'string': 'string'
                    },
                    'StartCommand': 'string',
                    'Port': 'string',
                    'RuntimeEnvironmentSecrets': {
                        'string': 'string'
                    }
                },
                'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
            },
            'AutoDeploymentsEnabled': True|False,
            'AuthenticationConfiguration': {
                'ConnectionArn': 'string',
                'AccessRoleArn': 'string'
            }
        },
        'InstanceConfiguration': {
            'Cpu': 'string',
            'Memory': 'string',
            'InstanceRoleArn': 'string'
        },
        'EncryptionConfiguration': {
            'KmsKey': 'string'
        },
        'HealthCheckConfiguration': {
            'Protocol': 'TCP'|'HTTP',
            'Path': 'string',
            'Interval': 123,
            'Timeout': 123,
            'HealthyThreshold': 123,
            'UnhealthyThreshold': 123
        },
        'AutoScalingConfigurationSummary': {
            'AutoScalingConfigurationArn': 'string',
            'AutoScalingConfigurationName': 'string',
            'AutoScalingConfigurationRevision': 123,
            'Status': 'ACTIVE'|'INACTIVE',
            'CreatedAt': datetime(2015, 1, 1),
            'HasAssociatedService': True|False,
            'IsDefault': True|False
        },
        'NetworkConfiguration': {
            'EgressConfiguration': {
                'EgressType': 'DEFAULT'|'VPC',
                'VpcConnectorArn': 'string'
            },
            'IngressConfiguration': {
                'IsPubliclyAccessible': True|False
            },
            'IpAddressType': 'IPV4'|'DUAL_STACK'
        },
        'ObservabilityConfiguration': {
            'ObservabilityEnabled': True|False,
            'ObservabilityConfigurationArn': 'string'
        }
    },
    'OperationId': 'string'
}

Response Structure

• (dict) --

  • Service (dict) --

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

    • ServiceName (string) --

      The customer-provided service name.

    • ServiceId (string) --

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

    • ServiceArn (string) --

      The Amazon Resource Name (ARN) of this service.

    • ServiceUrl (string) --

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

    • CreatedAt (datetime) --

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

    • UpdatedAt (datetime) --

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

    • DeletedAt (datetime) --

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

    • Status (string) --

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

      • CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

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

    • SourceConfiguration (dict) --

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

      • CodeRepository (dict) --

        The description of a source code repository.

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

        • RepositoryUrl (string) --

          The location of the repository that contains the source code.

        • SourceCodeVersion (dict) --

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

          • Type (string) --

            The type of version identifier.

            For a git-based repository, branches represent versions.

          • Value (string) --

            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.

        • CodeConfiguration (dict) --

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

          • ConfigurationSource (string) --

            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 (dict) --

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

            • Runtime (string) --

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

            • BuildCommand (string) --

              The command App Runner runs to build your application.

            • StartCommand (string) --

              The command App Runner runs to start your application.

            • Port (string) --

              The port that your application listens to in the container.

              Default: 8080

            • RuntimeEnvironmentVariables (dict) --

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

              • (string) --

                • (string) --

            • RuntimeEnvironmentSecrets (dict) --

              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.

              • (string) --

                • (string) --

        • SourceDirectory (string) --

          The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.

      • ImageRepository (dict) --

        The description of a source image repository.

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

        • ImageIdentifier (string) --

          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.

        • ImageConfiguration (dict) --

          Configuration for running the identified image.

          • RuntimeEnvironmentVariables (dict) --

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

            • (string) --

              • (string) --

          • StartCommand (string) --

            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.

          • Port (string) --

            The port that your application listens to in the container.

            Default: 8080

          • RuntimeEnvironmentSecrets (dict) --

            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.

            • (string) --

              • (string) --

        • ImageRepositoryType (string) --

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

      • AutoDeploymentsEnabled (boolean) --

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

      • AuthenticationConfiguration (dict) --

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

        • ConnectionArn (string) --

          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.

        • AccessRoleArn (string) --

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

    • InstanceConfiguration (dict) --

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

      • Cpu (string) --

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

        Default: 1 vCPU

      • Memory (string) --

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

        Default: 2 GB

      • InstanceRoleArn (string) --

        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.

    • EncryptionConfiguration (dict) --

      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.

      • KmsKey (string) --

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

    • HealthCheckConfiguration (dict) --

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

      • Protocol (string) --

        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

      • Path (string) --

        The URL that health check requests are sent to.

        Path is only applicable when you set Protocol to HTTP.

        Default: "/"

      • Interval (integer) --

        The time interval, in seconds, between health checks.

        Default: 5

      • Timeout (integer) --

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

        Default: 2

      • HealthyThreshold (integer) --

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

        Default: 1

      • UnhealthyThreshold (integer) --

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

        Default: 5

    • AutoScalingConfigurationSummary (dict) --

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

      • AutoScalingConfigurationArn (string) --

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

      • AutoScalingConfigurationName (string) --

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

      • AutoScalingConfigurationRevision (integer) --

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

      • Status (string) --

        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.

      • CreatedAt (datetime) --

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

      • HasAssociatedService (boolean) --

        Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

      • IsDefault (boolean) --

        Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under the same AutoScalingConfigurationName.

    • NetworkConfiguration (dict) --

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

      • EgressConfiguration (dict) --

        Network configuration settings for outbound message traffic.

        • EgressType (string) --

          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.

        • VpcConnectorArn (string) --

          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.

      • IngressConfiguration (dict) --

        Network configuration settings for inbound message traffic.

        • IsPubliclyAccessible (boolean) --

          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.

      • IpAddressType (string) --

        App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual-stack (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you do not specify an IpAddressType, it defaults to select IPv4.

    • ObservabilityConfiguration (dict) --

      The observability configuration of this service.

      • ObservabilityEnabled (boolean) --

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

      • ObservabilityConfigurationArn (string) --

        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

  • OperationId (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.

{'Service': {'NetworkConfiguration': {'IpAddressType': 'IPV4 | DUAL_STACK'}}}

Resume an active App Runner service. App Runner provisions compute capacity for the service.

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

See also: AWS API Documentation

Request Syntax

client.resume_service(
    ServiceArn='string'
)

type ServiceArn:

string

param ServiceArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'Service': {
        'ServiceName': 'string',
        'ServiceId': 'string',
        'ServiceArn': 'string',
        'ServiceUrl': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'DeletedAt': datetime(2015, 1, 1),
        'Status': 'CREATE_FAILED'|'RUNNING'|'DELETED'|'DELETE_FAILED'|'PAUSED'|'OPERATION_IN_PROGRESS',
        'SourceConfiguration': {
            'CodeRepository': {
                'RepositoryUrl': 'string',
                'SourceCodeVersion': {
                    'Type': 'BRANCH',
                    'Value': 'string'
                },
                'CodeConfiguration': {
                    'ConfigurationSource': 'REPOSITORY'|'API',
                    'CodeConfigurationValues': {
                        'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
                        'BuildCommand': 'string',
                        'StartCommand': 'string',
                        'Port': 'string',
                        'RuntimeEnvironmentVariables': {
                            'string': 'string'
                        },
                        'RuntimeEnvironmentSecrets': {
                            'string': 'string'
                        }
                    }
                },
                'SourceDirectory': 'string'
            },
            'ImageRepository': {
                'ImageIdentifier': 'string',
                'ImageConfiguration': {
                    'RuntimeEnvironmentVariables': {
                        'string': 'string'
                    },
                    'StartCommand': 'string',
                    'Port': 'string',
                    'RuntimeEnvironmentSecrets': {
                        'string': 'string'
                    }
                },
                'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
            },
            'AutoDeploymentsEnabled': True|False,
            'AuthenticationConfiguration': {
                'ConnectionArn': 'string',
                'AccessRoleArn': 'string'
            }
        },
        'InstanceConfiguration': {
            'Cpu': 'string',
            'Memory': 'string',
            'InstanceRoleArn': 'string'
        },
        'EncryptionConfiguration': {
            'KmsKey': 'string'
        },
        'HealthCheckConfiguration': {
            'Protocol': 'TCP'|'HTTP',
            'Path': 'string',
            'Interval': 123,
            'Timeout': 123,
            'HealthyThreshold': 123,
            'UnhealthyThreshold': 123
        },
        'AutoScalingConfigurationSummary': {
            'AutoScalingConfigurationArn': 'string',
            'AutoScalingConfigurationName': 'string',
            'AutoScalingConfigurationRevision': 123,
            'Status': 'ACTIVE'|'INACTIVE',
            'CreatedAt': datetime(2015, 1, 1),
            'HasAssociatedService': True|False,
            'IsDefault': True|False
        },
        'NetworkConfiguration': {
            'EgressConfiguration': {
                'EgressType': 'DEFAULT'|'VPC',
                'VpcConnectorArn': 'string'
            },
            'IngressConfiguration': {
                'IsPubliclyAccessible': True|False
            },
            'IpAddressType': 'IPV4'|'DUAL_STACK'
        },
        'ObservabilityConfiguration': {
            'ObservabilityEnabled': True|False,
            'ObservabilityConfigurationArn': 'string'
        }
    },
    'OperationId': 'string'
}

Response Structure

• (dict) --

  • Service (dict) --

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

    • ServiceName (string) --

      The customer-provided service name.

    • ServiceId (string) --

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

    • ServiceArn (string) --

      The Amazon Resource Name (ARN) of this service.

    • ServiceUrl (string) --

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

    • CreatedAt (datetime) --

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

    • UpdatedAt (datetime) --

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

    • DeletedAt (datetime) --

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

    • Status (string) --

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

      • CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

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

    • SourceConfiguration (dict) --

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

      • CodeRepository (dict) --

        The description of a source code repository.

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

        • RepositoryUrl (string) --

          The location of the repository that contains the source code.

        • SourceCodeVersion (dict) --

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

          • Type (string) --

            The type of version identifier.

            For a git-based repository, branches represent versions.

          • Value (string) --

            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.

        • CodeConfiguration (dict) --

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

          • ConfigurationSource (string) --

            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 (dict) --

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

            • Runtime (string) --

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

            • BuildCommand (string) --

              The command App Runner runs to build your application.

            • StartCommand (string) --

              The command App Runner runs to start your application.

            • Port (string) --

              The port that your application listens to in the container.

              Default: 8080

            • RuntimeEnvironmentVariables (dict) --

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

              • (string) --

                • (string) --

            • RuntimeEnvironmentSecrets (dict) --

              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.

              • (string) --

                • (string) --

        • SourceDirectory (string) --

          The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.

      • ImageRepository (dict) --

        The description of a source image repository.

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

        • ImageIdentifier (string) --

          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.

        • ImageConfiguration (dict) --

          Configuration for running the identified image.

          • RuntimeEnvironmentVariables (dict) --

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

            • (string) --

              • (string) --

          • StartCommand (string) --

            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.

          • Port (string) --

            The port that your application listens to in the container.

            Default: 8080

          • RuntimeEnvironmentSecrets (dict) --

            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.

            • (string) --

              • (string) --

        • ImageRepositoryType (string) --

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

      • AutoDeploymentsEnabled (boolean) --

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

      • AuthenticationConfiguration (dict) --

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

        • ConnectionArn (string) --

          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.

        • AccessRoleArn (string) --

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

    • InstanceConfiguration (dict) --

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

      • Cpu (string) --

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

        Default: 1 vCPU

      • Memory (string) --

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

        Default: 2 GB

      • InstanceRoleArn (string) --

        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.

    • EncryptionConfiguration (dict) --

      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.

      • KmsKey (string) --

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

    • HealthCheckConfiguration (dict) --

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

      • Protocol (string) --

        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

      • Path (string) --

        The URL that health check requests are sent to.

        Path is only applicable when you set Protocol to HTTP.

        Default: "/"

      • Interval (integer) --

        The time interval, in seconds, between health checks.

        Default: 5

      • Timeout (integer) --

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

        Default: 2

      • HealthyThreshold (integer) --

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

        Default: 1

      • UnhealthyThreshold (integer) --

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

        Default: 5

    • AutoScalingConfigurationSummary (dict) --

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

      • AutoScalingConfigurationArn (string) --

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

      • AutoScalingConfigurationName (string) --

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

      • AutoScalingConfigurationRevision (integer) --

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

      • Status (string) --

        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.

      • CreatedAt (datetime) --

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

      • HasAssociatedService (boolean) --

        Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

      • IsDefault (boolean) --

        Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under the same AutoScalingConfigurationName.

    • NetworkConfiguration (dict) --

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

      • EgressConfiguration (dict) --

        Network configuration settings for outbound message traffic.

        • EgressType (string) --

          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.

        • VpcConnectorArn (string) --

          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.

      • IngressConfiguration (dict) --

        Network configuration settings for inbound message traffic.

        • IsPubliclyAccessible (boolean) --

          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.

      • IpAddressType (string) --

        App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual-stack (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you do not specify an IpAddressType, it defaults to select IPv4.

    • ObservabilityConfiguration (dict) --

      The observability configuration of this service.

      • ObservabilityEnabled (boolean) --

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

      • ObservabilityConfigurationArn (string) --

        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

  • OperationId (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.

{'NetworkConfiguration': {'IpAddressType': 'IPV4 | DUAL_STACK'}}

{'Service': {'NetworkConfiguration': {'IpAddressType': 'IPV4 | DUAL_STACK'}}}

Update an App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service. These can be set only when you create the service.

To update the tags applied to your service, use the separate actions TagResource and UntagResource.

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

See also: AWS API Documentation

Request Syntax

client.update_service(
    ServiceArn='string',
    SourceConfiguration={
        'CodeRepository': {
            'RepositoryUrl': 'string',
            'SourceCodeVersion': {
                'Type': 'BRANCH',
                'Value': 'string'
            },
            'CodeConfiguration': {
                'ConfigurationSource': 'REPOSITORY'|'API',
                'CodeConfigurationValues': {
                    'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
                    'BuildCommand': 'string',
                    'StartCommand': 'string',
                    'Port': 'string',
                    'RuntimeEnvironmentVariables': {
                        'string': 'string'
                    },
                    'RuntimeEnvironmentSecrets': {
                        'string': 'string'
                    }
                }
            },
            'SourceDirectory': 'string'
        },
        'ImageRepository': {
            'ImageIdentifier': 'string',
            'ImageConfiguration': {
                'RuntimeEnvironmentVariables': {
                    'string': 'string'
                },
                'StartCommand': 'string',
                'Port': 'string',
                'RuntimeEnvironmentSecrets': {
                    'string': 'string'
                }
            },
            'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
        },
        'AutoDeploymentsEnabled': True|False,
        'AuthenticationConfiguration': {
            'ConnectionArn': 'string',
            'AccessRoleArn': 'string'
        }
    },
    InstanceConfiguration={
        'Cpu': 'string',
        'Memory': 'string',
        'InstanceRoleArn': 'string'
    },
    AutoScalingConfigurationArn='string',
    HealthCheckConfiguration={
        'Protocol': 'TCP'|'HTTP',
        'Path': 'string',
        'Interval': 123,
        'Timeout': 123,
        'HealthyThreshold': 123,
        'UnhealthyThreshold': 123
    },
    NetworkConfiguration={
        'EgressConfiguration': {
            'EgressType': 'DEFAULT'|'VPC',
            'VpcConnectorArn': 'string'
        },
        'IngressConfiguration': {
            'IsPubliclyAccessible': True|False
        },
        'IpAddressType': 'IPV4'|'DUAL_STACK'
    },
    ObservabilityConfiguration={
        'ObservabilityEnabled': True|False,
        'ObservabilityConfigurationArn': 'string'
    }
)

type ServiceArn:

string

param ServiceArn:

[REQUIRED]

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

type SourceConfiguration:

dict

param SourceConfiguration:

The source configuration to apply to the App Runner service.

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

• CodeRepository (dict) --

  The description of a source code repository.

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

  • RepositoryUrl (string) -- [REQUIRED]

    The location of the repository that contains the source code.

  • SourceCodeVersion (dict) -- [REQUIRED]

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

    • Type (string) -- [REQUIRED]

      The type of version identifier.

      For a git-based repository, branches represent versions.

    • Value (string) -- [REQUIRED]

      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.

  • CodeConfiguration (dict) --

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

    • ConfigurationSource (string) -- [REQUIRED]

      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 (dict) --

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

      • Runtime (string) -- [REQUIRED]

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

      • BuildCommand (string) --

        The command App Runner runs to build your application.

      • StartCommand (string) --

        The command App Runner runs to start your application.

      • Port (string) --

        The port that your application listens to in the container.

        Default: 8080

      • RuntimeEnvironmentVariables (dict) --

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

        • (string) --

          • (string) --

      • RuntimeEnvironmentSecrets (dict) --

        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.

        • (string) --

          • (string) --

  • SourceDirectory (string) --

    The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.

• ImageRepository (dict) --

  The description of a source image repository.

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

  • ImageIdentifier (string) -- [REQUIRED]

    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.

  • ImageConfiguration (dict) --

    Configuration for running the identified image.

    • RuntimeEnvironmentVariables (dict) --

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

      • (string) --

        • (string) --

    • StartCommand (string) --

      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.

    • Port (string) --

      The port that your application listens to in the container.

      Default: 8080

    • RuntimeEnvironmentSecrets (dict) --

      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.

      • (string) --

        • (string) --

  • ImageRepositoryType (string) -- [REQUIRED]

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

• AutoDeploymentsEnabled (boolean) --

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

• AuthenticationConfiguration (dict) --

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

  • ConnectionArn (string) --

    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.

  • AccessRoleArn (string) --

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

type InstanceConfiguration:

dict

param InstanceConfiguration:

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

• Cpu (string) --

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

  Default: 1 vCPU

• Memory (string) --

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

  Default: 2 GB

• InstanceRoleArn (string) --

  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.

type AutoScalingConfigurationArn:

string

param AutoScalingConfigurationArn:

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

type HealthCheckConfiguration:

dict

param HealthCheckConfiguration:

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

• Protocol (string) --

  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

• Path (string) --

  The URL that health check requests are sent to.

  Path is only applicable when you set Protocol to HTTP.

  Default: "/"

• Interval (integer) --

  The time interval, in seconds, between health checks.

  Default: 5

• Timeout (integer) --

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

  Default: 2

• HealthyThreshold (integer) --

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

  Default: 1

• UnhealthyThreshold (integer) --

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

  Default: 5

type NetworkConfiguration:

dict

param NetworkConfiguration:

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

• EgressConfiguration (dict) --

  Network configuration settings for outbound message traffic.

  • EgressType (string) --

    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.

  • VpcConnectorArn (string) --

    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.

• IngressConfiguration (dict) --

  Network configuration settings for inbound message traffic.

  • IsPubliclyAccessible (boolean) --

    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.

• IpAddressType (string) --

  App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual-stack (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you do not specify an IpAddressType, it defaults to select IPv4.

type ObservabilityConfiguration:

dict

param ObservabilityConfiguration:

The observability configuration of your service.

• ObservabilityEnabled (boolean) -- [REQUIRED]

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

• ObservabilityConfigurationArn (string) --

  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

rtype:

dict

returns:

Response Syntax

{
    'Service': {
        'ServiceName': 'string',
        'ServiceId': 'string',
        'ServiceArn': 'string',
        'ServiceUrl': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'DeletedAt': datetime(2015, 1, 1),
        'Status': 'CREATE_FAILED'|'RUNNING'|'DELETED'|'DELETE_FAILED'|'PAUSED'|'OPERATION_IN_PROGRESS',
        'SourceConfiguration': {
            'CodeRepository': {
                'RepositoryUrl': 'string',
                'SourceCodeVersion': {
                    'Type': 'BRANCH',
                    'Value': 'string'
                },
                'CodeConfiguration': {
                    'ConfigurationSource': 'REPOSITORY'|'API',
                    'CodeConfigurationValues': {
                        'Runtime': 'PYTHON_3'|'NODEJS_12'|'NODEJS_14'|'CORRETTO_8'|'CORRETTO_11'|'NODEJS_16'|'GO_1'|'DOTNET_6'|'PHP_81'|'RUBY_31',
                        'BuildCommand': 'string',
                        'StartCommand': 'string',
                        'Port': 'string',
                        'RuntimeEnvironmentVariables': {
                            'string': 'string'
                        },
                        'RuntimeEnvironmentSecrets': {
                            'string': 'string'
                        }
                    }
                },
                'SourceDirectory': 'string'
            },
            'ImageRepository': {
                'ImageIdentifier': 'string',
                'ImageConfiguration': {
                    'RuntimeEnvironmentVariables': {
                        'string': 'string'
                    },
                    'StartCommand': 'string',
                    'Port': 'string',
                    'RuntimeEnvironmentSecrets': {
                        'string': 'string'
                    }
                },
                'ImageRepositoryType': 'ECR'|'ECR_PUBLIC'
            },
            'AutoDeploymentsEnabled': True|False,
            'AuthenticationConfiguration': {
                'ConnectionArn': 'string',
                'AccessRoleArn': 'string'
            }
        },
        'InstanceConfiguration': {
            'Cpu': 'string',
            'Memory': 'string',
            'InstanceRoleArn': 'string'
        },
        'EncryptionConfiguration': {
            'KmsKey': 'string'
        },
        'HealthCheckConfiguration': {
            'Protocol': 'TCP'|'HTTP',
            'Path': 'string',
            'Interval': 123,
            'Timeout': 123,
            'HealthyThreshold': 123,
            'UnhealthyThreshold': 123
        },
        'AutoScalingConfigurationSummary': {
            'AutoScalingConfigurationArn': 'string',
            'AutoScalingConfigurationName': 'string',
            'AutoScalingConfigurationRevision': 123,
            'Status': 'ACTIVE'|'INACTIVE',
            'CreatedAt': datetime(2015, 1, 1),
            'HasAssociatedService': True|False,
            'IsDefault': True|False
        },
        'NetworkConfiguration': {
            'EgressConfiguration': {
                'EgressType': 'DEFAULT'|'VPC',
                'VpcConnectorArn': 'string'
            },
            'IngressConfiguration': {
                'IsPubliclyAccessible': True|False
            },
            'IpAddressType': 'IPV4'|'DUAL_STACK'
        },
        'ObservabilityConfiguration': {
            'ObservabilityEnabled': True|False,
            'ObservabilityConfigurationArn': 'string'
        }
    },
    'OperationId': 'string'
}

Response Structure

• (dict) --

  • Service (dict) --

    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.

    • ServiceName (string) --

      The customer-provided service name.

    • ServiceId (string) --

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

    • ServiceArn (string) --

      The Amazon Resource Name (ARN) of this service.

    • ServiceUrl (string) --

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

    • CreatedAt (datetime) --

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

    • UpdatedAt (datetime) --

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

    • DeletedAt (datetime) --

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

    • Status (string) --

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

      • CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

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

    • SourceConfiguration (dict) --

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

      • CodeRepository (dict) --

        The description of a source code repository.

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

        • RepositoryUrl (string) --

          The location of the repository that contains the source code.

        • SourceCodeVersion (dict) --

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

          • Type (string) --

            The type of version identifier.

            For a git-based repository, branches represent versions.

          • Value (string) --

            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.

        • CodeConfiguration (dict) --

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

          • ConfigurationSource (string) --

            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 (dict) --

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

            • Runtime (string) --

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

            • BuildCommand (string) --

              The command App Runner runs to build your application.

            • StartCommand (string) --

              The command App Runner runs to start your application.

            • Port (string) --

              The port that your application listens to in the container.

              Default: 8080

            • RuntimeEnvironmentVariables (dict) --

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

              • (string) --

                • (string) --

            • RuntimeEnvironmentSecrets (dict) --

              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.

              • (string) --

                • (string) --

        • SourceDirectory (string) --

          The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.

      • ImageRepository (dict) --

        The description of a source image repository.

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

        • ImageIdentifier (string) --

          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.

        • ImageConfiguration (dict) --

          Configuration for running the identified image.

          • RuntimeEnvironmentVariables (dict) --

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

            • (string) --

              • (string) --

          • StartCommand (string) --

            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.

          • Port (string) --

            The port that your application listens to in the container.

            Default: 8080

          • RuntimeEnvironmentSecrets (dict) --

            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.

            • (string) --

              • (string) --

        • ImageRepositoryType (string) --

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

      • AutoDeploymentsEnabled (boolean) --

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

      • AuthenticationConfiguration (dict) --

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

        • ConnectionArn (string) --

          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.

        • AccessRoleArn (string) --

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

    • InstanceConfiguration (dict) --

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

      • Cpu (string) --

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

        Default: 1 vCPU

      • Memory (string) --

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

        Default: 2 GB

      • InstanceRoleArn (string) --

        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.

    • EncryptionConfiguration (dict) --

      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.

      • KmsKey (string) --

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

    • HealthCheckConfiguration (dict) --

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

      • Protocol (string) --

        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

      • Path (string) --

        The URL that health check requests are sent to.

        Path is only applicable when you set Protocol to HTTP.

        Default: "/"

      • Interval (integer) --

        The time interval, in seconds, between health checks.

        Default: 5

      • Timeout (integer) --

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

        Default: 2

      • HealthyThreshold (integer) --

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

        Default: 1

      • UnhealthyThreshold (integer) --

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

        Default: 5

    • AutoScalingConfigurationSummary (dict) --

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

      • AutoScalingConfigurationArn (string) --

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

      • AutoScalingConfigurationName (string) --

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

      • AutoScalingConfigurationRevision (integer) --

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

      • Status (string) --

        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.

      • CreatedAt (datetime) --

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

      • HasAssociatedService (boolean) --

        Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

      • IsDefault (boolean) --

        Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under the same AutoScalingConfigurationName.

    • NetworkConfiguration (dict) --

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

      • EgressConfiguration (dict) --

        Network configuration settings for outbound message traffic.

        • EgressType (string) --

          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.

        • VpcConnectorArn (string) --

          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.

      • IngressConfiguration (dict) --

        Network configuration settings for inbound message traffic.

        • IsPubliclyAccessible (boolean) --

          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.

      • IpAddressType (string) --

        App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual-stack (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you do not specify an IpAddressType, it defaults to select IPv4.

    • ObservabilityConfiguration (dict) --

      The observability configuration of this service.

      • ObservabilityEnabled (boolean) --

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

      • ObservabilityConfigurationArn (string) --

        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

  • OperationId (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.