CfnServiceProps

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

Bases: object

Properties for defining a AWS::AppRunner::Service.

Parameters
Link

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

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_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_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"
    ),
    service_name="serviceName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

auto_scaling_configuration_arn

AWS::AppRunner::Service.AutoScalingConfigurationArn.

Link

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

Return type

Optional[str]

encryption_configuration

AWS::AppRunner::Service.EncryptionConfiguration.

Link

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

Return type

Union[IResolvable, EncryptionConfigurationProperty, None]

health_check_configuration

AWS::AppRunner::Service.HealthCheckConfiguration.

Link

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

Return type

Union[IResolvable, HealthCheckConfigurationProperty, None]

instance_configuration

AWS::AppRunner::Service.InstanceConfiguration.

Link

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

Return type

Union[IResolvable, InstanceConfigurationProperty, None]

service_name

AWS::AppRunner::Service.ServiceName.

Link

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

Return type

Optional[str]

source_configuration

AWS::AppRunner::Service.SourceConfiguration.

Link

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

Return type

Union[SourceConfigurationProperty, IResolvable]

tags

AWS::AppRunner::Service.Tags.

Link

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

Return type

Optional[List[CfnTag]]