CfnService

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

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::AppRunner::Service.

CloudformationResource

AWS::AppRunner::Service

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 = apprunner.CfnService(self, "MyCfnService",
    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"
    )]
)

Create a new AWS::AppRunner::Service.

Parameters

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::AppRunner::Service'
attr_service_arn

ServiceArn

Type

cloudformationAttribute

Return type

str

attr_service_id

ServiceId

Type

cloudformationAttribute

Return type

str

attr_service_url

ServiceUrl

Type

cloudformationAttribute

Return type

str

attr_status

Status

Type

cloudformationAttribute

Return type

str

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]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[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]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

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]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

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

TagManager

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AuthenticationConfigurationProperty

class CfnService.AuthenticationConfigurationProperty(*, access_role_arn=None, connection_arn=None)

Bases: object

Parameters
  • access_role_arn (Optional[str]) – CfnService.AuthenticationConfigurationProperty.AccessRoleArn.

  • connection_arn (Optional[str]) – CfnService.AuthenticationConfigurationProperty.ConnectionArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-authenticationconfiguration.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

authentication_configuration_property = apprunner.CfnService.AuthenticationConfigurationProperty(
    access_role_arn="accessRoleArn",
    connection_arn="connectionArn"
)

Attributes

access_role_arn

CfnService.AuthenticationConfigurationProperty.AccessRoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-authenticationconfiguration.html#cfn-apprunner-service-authenticationconfiguration-accessrolearn

Return type

Optional[str]

connection_arn

CfnService.AuthenticationConfigurationProperty.ConnectionArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-authenticationconfiguration.html#cfn-apprunner-service-authenticationconfiguration-connectionarn

Return type

Optional[str]

CodeConfigurationProperty

class CfnService.CodeConfigurationProperty(*, code_configuration_values=None, configuration_source)

Bases: object

Parameters
  • code_configuration_values (Union[IResolvable, CodeConfigurationValuesProperty, None]) – CfnService.CodeConfigurationProperty.CodeConfigurationValues.

  • configuration_source (str) – CfnService.CodeConfigurationProperty.ConfigurationSource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.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

code_configuration_property = 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"
    )
)

Attributes

code_configuration_values

CfnService.CodeConfigurationProperty.CodeConfigurationValues.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html#cfn-apprunner-service-codeconfiguration-codeconfigurationvalues

Return type

Union[IResolvable, CodeConfigurationValuesProperty, None]

configuration_source

CfnService.CodeConfigurationProperty.ConfigurationSource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html#cfn-apprunner-service-codeconfiguration-configurationsource

Return type

str

CodeConfigurationValuesProperty

class CfnService.CodeConfigurationValuesProperty(*, build_command=None, port=None, runtime, runtime_environment_variables=None, start_command=None)

Bases: object

Parameters
  • build_command (Optional[str]) – CfnService.CodeConfigurationValuesProperty.BuildCommand.

  • port (Optional[str]) – CfnService.CodeConfigurationValuesProperty.Port.

  • runtime (str) – CfnService.CodeConfigurationValuesProperty.Runtime.

  • runtime_environment_variables (Union[IResolvable, Sequence[Union[IResolvable, KeyValuePairProperty]], None]) – CfnService.CodeConfigurationValuesProperty.RuntimeEnvironmentVariables.

  • start_command (Optional[str]) – CfnService.CodeConfigurationValuesProperty.StartCommand.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.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

code_configuration_values_property = 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"
)

Attributes

build_command

CfnService.CodeConfigurationValuesProperty.BuildCommand.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-buildcommand

Return type

Optional[str]

port

CfnService.CodeConfigurationValuesProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-port

Return type

Optional[str]

runtime

CfnService.CodeConfigurationValuesProperty.Runtime.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtime

Return type

str

runtime_environment_variables

CfnService.CodeConfigurationValuesProperty.RuntimeEnvironmentVariables.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtimeenvironmentvariables

Return type

Union[IResolvable, List[Union[IResolvable, KeyValuePairProperty]], None]

start_command

CfnService.CodeConfigurationValuesProperty.StartCommand.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-startcommand

Return type

Optional[str]

CodeRepositoryProperty

class CfnService.CodeRepositoryProperty(*, code_configuration=None, repository_url, source_code_version)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.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

code_repository_property = 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"
        )
    )
)

Attributes

code_configuration

CfnService.CodeRepositoryProperty.CodeConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-codeconfiguration

Return type

Union[IResolvable, CodeConfigurationProperty, None]

repository_url

CfnService.CodeRepositoryProperty.RepositoryUrl.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-repositoryurl

Return type

str

source_code_version

CfnService.CodeRepositoryProperty.SourceCodeVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-sourcecodeversion

Return type

Union[IResolvable, SourceCodeVersionProperty]

EncryptionConfigurationProperty

class CfnService.EncryptionConfigurationProperty(*, kms_key)

Bases: object

Parameters

kms_key (str) – CfnService.EncryptionConfigurationProperty.KmsKey.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-encryptionconfiguration.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

encryption_configuration_property = apprunner.CfnService.EncryptionConfigurationProperty(
    kms_key="kmsKey"
)

Attributes

kms_key

CfnService.EncryptionConfigurationProperty.KmsKey.

Link

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

Return type

str

HealthCheckConfigurationProperty

class CfnService.HealthCheckConfigurationProperty(*, healthy_threshold=None, interval=None, path=None, protocol=None, timeout=None, unhealthy_threshold=None)

Bases: object

Parameters
  • healthy_threshold (Union[int, float, None]) – CfnService.HealthCheckConfigurationProperty.HealthyThreshold.

  • interval (Union[int, float, None]) – CfnService.HealthCheckConfigurationProperty.Interval.

  • path (Optional[str]) – CfnService.HealthCheckConfigurationProperty.Path.

  • protocol (Optional[str]) – CfnService.HealthCheckConfigurationProperty.Protocol.

  • timeout (Union[int, float, None]) – CfnService.HealthCheckConfigurationProperty.Timeout.

  • unhealthy_threshold (Union[int, float, None]) – CfnService.HealthCheckConfigurationProperty.UnhealthyThreshold.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.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

health_check_configuration_property = apprunner.CfnService.HealthCheckConfigurationProperty(
    healthy_threshold=123,
    interval=123,
    path="path",
    protocol="protocol",
    timeout=123,
    unhealthy_threshold=123
)

Attributes

healthy_threshold

CfnService.HealthCheckConfigurationProperty.HealthyThreshold.

Link

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

Return type

Union[int, float, None]

interval

CfnService.HealthCheckConfigurationProperty.Interval.

Link

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

Return type

Union[int, float, None]

path

CfnService.HealthCheckConfigurationProperty.Path.

Link

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

Return type

Optional[str]

protocol

CfnService.HealthCheckConfigurationProperty.Protocol.

Link

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

Return type

Optional[str]

timeout

CfnService.HealthCheckConfigurationProperty.Timeout.

Link

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

Return type

Union[int, float, None]

unhealthy_threshold

CfnService.HealthCheckConfigurationProperty.UnhealthyThreshold.

Link

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

Return type

Union[int, float, None]

ImageConfigurationProperty

class CfnService.ImageConfigurationProperty(*, port=None, runtime_environment_variables=None, start_command=None)

Bases: object

Parameters
  • port (Optional[str]) – CfnService.ImageConfigurationProperty.Port.

  • runtime_environment_variables (Union[IResolvable, Sequence[Union[IResolvable, KeyValuePairProperty]], None]) – CfnService.ImageConfigurationProperty.RuntimeEnvironmentVariables.

  • start_command (Optional[str]) – CfnService.ImageConfigurationProperty.StartCommand.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.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

image_configuration_property = apprunner.CfnService.ImageConfigurationProperty(
    port="port",
    runtime_environment_variables=[apprunner.CfnService.KeyValuePairProperty(
        name="name",
        value="value"
    )],
    start_command="startCommand"
)

Attributes

port

CfnService.ImageConfigurationProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-port

Return type

Optional[str]

runtime_environment_variables

CfnService.ImageConfigurationProperty.RuntimeEnvironmentVariables.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-runtimeenvironmentvariables

Return type

Union[IResolvable, List[Union[IResolvable, KeyValuePairProperty]], None]

start_command

CfnService.ImageConfigurationProperty.StartCommand.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-startcommand

Return type

Optional[str]

ImageRepositoryProperty

class CfnService.ImageRepositoryProperty(*, image_configuration=None, image_identifier, image_repository_type)

Bases: object

Parameters
  • image_configuration (Union[IResolvable, ImageConfigurationProperty, None]) – CfnService.ImageRepositoryProperty.ImageConfiguration.

  • image_identifier (str) – CfnService.ImageRepositoryProperty.ImageIdentifier.

  • image_repository_type (str) – CfnService.ImageRepositoryProperty.ImageRepositoryType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.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

image_repository_property = 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"
    )
)

Attributes

image_configuration

CfnService.ImageRepositoryProperty.ImageConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html#cfn-apprunner-service-imagerepository-imageconfiguration

Return type

Union[IResolvable, ImageConfigurationProperty, None]

image_identifier

CfnService.ImageRepositoryProperty.ImageIdentifier.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html#cfn-apprunner-service-imagerepository-imageidentifier

Return type

str

image_repository_type

CfnService.ImageRepositoryProperty.ImageRepositoryType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html#cfn-apprunner-service-imagerepository-imagerepositorytype

Return type

str

InstanceConfigurationProperty

class CfnService.InstanceConfigurationProperty(*, cpu=None, instance_role_arn=None, memory=None)

Bases: object

Parameters
  • cpu (Optional[str]) – CfnService.InstanceConfigurationProperty.Cpu.

  • instance_role_arn (Optional[str]) – CfnService.InstanceConfigurationProperty.InstanceRoleArn.

  • memory (Optional[str]) – CfnService.InstanceConfigurationProperty.Memory.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.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

instance_configuration_property = apprunner.CfnService.InstanceConfigurationProperty(
    cpu="cpu",
    instance_role_arn="instanceRoleArn",
    memory="memory"
)

Attributes

cpu

CfnService.InstanceConfigurationProperty.Cpu.

Link

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

Return type

Optional[str]

instance_role_arn

CfnService.InstanceConfigurationProperty.InstanceRoleArn.

Link

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

Return type

Optional[str]

memory

CfnService.InstanceConfigurationProperty.Memory.

Link

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

Return type

Optional[str]

KeyValuePairProperty

class CfnService.KeyValuePairProperty(*, name=None, value=None)

Bases: object

Parameters
  • name (Optional[str]) – CfnService.KeyValuePairProperty.Name.

  • value (Optional[str]) – CfnService.KeyValuePairProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.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

key_value_pair_property = apprunner.CfnService.KeyValuePairProperty(
    name="name",
    value="value"
)

Attributes

name

CfnService.KeyValuePairProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html#cfn-apprunner-service-keyvaluepair-name

Return type

Optional[str]

value

CfnService.KeyValuePairProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html#cfn-apprunner-service-keyvaluepair-value

Return type

Optional[str]

SourceCodeVersionProperty

class CfnService.SourceCodeVersionProperty(*, type, value)

Bases: object

Parameters
  • type (str) – CfnService.SourceCodeVersionProperty.Type.

  • value (str) – CfnService.SourceCodeVersionProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourcecodeversion.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

source_code_version_property = apprunner.CfnService.SourceCodeVersionProperty(
    type="type",
    value="value"
)

Attributes

type

CfnService.SourceCodeVersionProperty.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourcecodeversion.html#cfn-apprunner-service-sourcecodeversion-type

Return type

str

value

CfnService.SourceCodeVersionProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourcecodeversion.html#cfn-apprunner-service-sourcecodeversion-value

Return type

str

SourceConfigurationProperty

class CfnService.SourceConfigurationProperty(*, authentication_configuration=None, auto_deployments_enabled=None, code_repository=None, image_repository=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.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

source_configuration_property = 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"
        )
    )
)

Attributes

authentication_configuration

CfnService.SourceConfigurationProperty.AuthenticationConfiguration.

Link

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

Return type

Union[IResolvable, AuthenticationConfigurationProperty, None]

auto_deployments_enabled

CfnService.SourceConfigurationProperty.AutoDeploymentsEnabled.

Link

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

Return type

Union[bool, IResolvable, None]

code_repository

CfnService.SourceConfigurationProperty.CodeRepository.

Link

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

Return type

Union[IResolvable, CodeRepositoryProperty, None]

image_repository

CfnService.SourceConfigurationProperty.ImageRepository.

Link

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

Return type

Union[IResolvable, ImageRepositoryProperty, None]