CfnServiceProps

class aws_cdk.aws_apprunner.CfnServiceProps(*, source_configuration, auto_scaling_configuration_arn=None, encryption_configuration=None, health_check_configuration=None, instance_configuration=None, network_configuration=None, observability_configuration=None, service_name=None, tags=None)

Bases: object

Properties for defining a CfnService.

Parameters:

• source_configuration (Union[IResolvable, SourceConfigurationProperty, Dict[str, Any]]) – The source to deploy to the App Runner service. It can be a code or an image repository.

• auto_scaling_configuration_arn (Optional[str]) – 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

• encryption_configuration (Union[IResolvable, EncryptionConfigurationProperty, Dict[str, Any], None]) – 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 AWS managed key .

• health_check_configuration (Union[IResolvable, HealthCheckConfigurationProperty, Dict[str, Any], None]) – The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.

• instance_configuration (Union[IResolvable, InstanceConfigurationProperty, Dict[str, Any], None]) – The runtime configuration of instances (scaling units) of your service.

• network_configuration (Union[IResolvable, NetworkConfigurationProperty, Dict[str, Any], None]) – Configuration settings related to network traffic of the web application that the App Runner service runs.

• observability_configuration (Union[IResolvable, ServiceObservabilityConfigurationProperty, Dict[str, Any], None]) – The observability configuration of your service.

• service_name (Optional[str]) – A name for the App Runner service. It must be unique across all the running App Runner services in your AWS account in the AWS Region . If you don’t specify a name, AWS CloudFormation generates a name for your service.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apprunner as apprunner

cfn_service_props = apprunner.CfnServiceProps(
    source_configuration=apprunner.CfnService.SourceConfigurationProperty(
        authentication_configuration=apprunner.CfnService.AuthenticationConfigurationProperty(
            access_role_arn="accessRoleArn",
            connection_arn="connectionArn"
        ),
        auto_deployments_enabled=False,
        code_repository=apprunner.CfnService.CodeRepositoryProperty(
            repository_url="repositoryUrl",
            source_code_version=apprunner.CfnService.SourceCodeVersionProperty(
                type="type",
                value="value"
            ),

            # the properties below are optional
            code_configuration=apprunner.CfnService.CodeConfigurationProperty(
                configuration_source="configurationSource",

                # the properties below are optional
                code_configuration_values=apprunner.CfnService.CodeConfigurationValuesProperty(
                    runtime="runtime",

                    # the properties below are optional
                    build_command="buildCommand",
                    port="port",
                    runtime_environment_secrets=[apprunner.CfnService.KeyValuePairProperty(
                        name="name",
                        value="value"
                    )],
                    runtime_environment_variables=[apprunner.CfnService.KeyValuePairProperty(
                        name="name",
                        value="value"
                    )],
                    start_command="startCommand"
                )
            )
        ),
        image_repository=apprunner.CfnService.ImageRepositoryProperty(
            image_identifier="imageIdentifier",
            image_repository_type="imageRepositoryType",

            # the properties below are optional
            image_configuration=apprunner.CfnService.ImageConfigurationProperty(
                port="port",
                runtime_environment_secrets=[apprunner.CfnService.KeyValuePairProperty(
                    name="name",
                    value="value"
                )],
                runtime_environment_variables=[apprunner.CfnService.KeyValuePairProperty(
                    name="name",
                    value="value"
                )],
                start_command="startCommand"
            )
        )
    ),

    # the properties below are optional
    auto_scaling_configuration_arn="autoScalingConfigurationArn",
    encryption_configuration=apprunner.CfnService.EncryptionConfigurationProperty(
        kms_key="kmsKey"
    ),
    health_check_configuration=apprunner.CfnService.HealthCheckConfigurationProperty(
        healthy_threshold=123,
        interval=123,
        path="path",
        protocol="protocol",
        timeout=123,
        unhealthy_threshold=123
    ),
    instance_configuration=apprunner.CfnService.InstanceConfigurationProperty(
        cpu="cpu",
        instance_role_arn="instanceRoleArn",
        memory="memory"
    ),
    network_configuration=apprunner.CfnService.NetworkConfigurationProperty(
        egress_configuration=apprunner.CfnService.EgressConfigurationProperty(
            egress_type="egressType",

            # the properties below are optional
            vpc_connector_arn="vpcConnectorArn"
        ),
        ingress_configuration=apprunner.CfnService.IngressConfigurationProperty(
            is_publicly_accessible=False
        )
    ),
    observability_configuration=apprunner.CfnService.ServiceObservabilityConfigurationProperty(
        observability_enabled=False,

        # the properties below are optional
        observability_configuration_arn="observabilityConfigurationArn"
    ),
    service_name="serviceName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

auto_scaling_configuration_arn

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-autoscalingconfigurationarn

encryption_configuration

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 AWS managed key .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-encryptionconfiguration

health_check_configuration

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-healthcheckconfiguration

instance_configuration

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-instanceconfiguration

network_configuration

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-networkconfiguration

observability_configuration

The observability configuration of your service.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-observabilityconfiguration

service_name

A name for the App Runner service.

It must be unique across all the running App Runner services in your AWS account in the AWS Region .

If you don’t specify a name, AWS CloudFormation generates a name for your service.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-servicename

source_configuration

The source to deploy to the App Runner service.

It can be a code or an image repository.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-sourceconfiguration

tags

An optional list of metadata items that you can associate with the App Runner service resource.

A tag is a key-value pair.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-tags