Class: AWSCDK::AppRunner::CfnService::CodeConfigurationValuesProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_runner/cfn_service.rb

Overview

Describes the basic configuration needed for building and running an AWS App Runner service.

This type doesn't support the full set of possible configuration options. Fur full configuration capabilities, use a apprunner.yaml file in the source code repository.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(runtime:, build_command: nil, port: nil, runtime_environment_secrets: nil, runtime_environment_variables: nil, start_command: nil) ⇒ CodeConfigurationValuesProperty

Returns a new instance of CodeConfigurationValuesProperty.

Parameters:

  • runtime (String) —

    A runtime environment type for building and running an App Runner service.

  • build_command (String, nil) (defaults to: nil) —

    The command App Runner runs to build your application.

  • port (String, nil) (defaults to: nil) —

    The port that your application listens to in the container.

  • runtime_environment_secrets (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::AppRunner::CfnService::KeyValuePairProperty>, nil) (defaults to: nil) —

    An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable.

  • runtime_environment_variables (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::AppRunner::CfnService::KeyValuePairProperty>, nil) (defaults to: nil) —

    The environment variables that are available to your running AWS App Runner service.

  • start_command (String, nil) (defaults to: nil) —

    The command App Runner runs to start your application.



764
765
766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'app_runner/cfn_service.rb', line 764

def initialize(runtime:, build_command: nil, port: nil, runtime_environment_secrets: nil, runtime_environment_variables: nil, start_command: nil)
  @runtime = runtime
  Jsii::Type.check_type(@runtime, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "runtime")
  @build_command = build_command
  Jsii::Type.check_type(@build_command, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "buildCommand") unless @build_command.nil?
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "port") unless @port.nil?
  @runtime_environment_secrets = runtime_environment_secrets
  Jsii::Type.check_type(@runtime_environment_secrets, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwcnVubmVyLkNmblNlcnZpY2UuS2V5VmFsdWVQYWlyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "runtimeEnvironmentSecrets") unless @runtime_environment_secrets.nil?
  @runtime_environment_variables = runtime_environment_variables
  Jsii::Type.check_type(@runtime_environment_variables, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwcnVubmVyLkNmblNlcnZpY2UuS2V5VmFsdWVQYWlyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "runtimeEnvironmentVariables") unless @runtime_environment_variables.nil?
  @start_command = start_command
  Jsii::Type.check_type(@start_command, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "startCommand") unless @start_command.nil?
end

Instance Attribute Details

#build_command ⇒ String? (readonly)

The command App Runner runs to build your application.

Returns:

  • (String, nil)

See Also:



790
791
792
 
# File 'app_runner/cfn_service.rb', line 790

def build_command
  @build_command
end

#port ⇒ String? (readonly)

The port that your application listens to in the container.

Default: 8080

Returns:

  • (String, nil)

See Also:



797
798
799
 
# File 'app_runner/cfn_service.rb', line 797

def port
  @port
end

#runtime ⇒ String (readonly)

A runtime environment type for building and running an App Runner service.

It represents a programming language runtime.

Returns:

  • (String)

See Also:



785
786
787
 
# File 'app_runner/cfn_service.rb', line 785

def runtime
  @runtime
end

#runtime_environment_secrets ⇒ AWSCDK::IResolvable, ... (readonly)

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 AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.

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

Returns:

See Also:



807
808
809
 
# File 'app_runner/cfn_service.rb', line 807

def runtime_environment_secrets
  @runtime_environment_secrets
end

#runtime_environment_variables ⇒ AWSCDK::IResolvable, ... (readonly)

The environment variables that are available to your running AWS App Runner service.

An array of key-value pairs.

Returns:

See Also:



814
815
816
 
# File 'app_runner/cfn_service.rb', line 814

def runtime_environment_variables
  @runtime_environment_variables
end

#start_command ⇒ String? (readonly)

The command App Runner runs to start your application.

Returns:

  • (String, nil)

See Also:



819
820
821
 
# File 'app_runner/cfn_service.rb', line 819

def start_command
  @start_command
end

Class Method Details

.jsii_properties ⇒ Object 



821
822
823
824
825
826
827
828
829
830
 
# File 'app_runner/cfn_service.rb', line 821

def self.jsii_properties
  {
    :runtime => "runtime",
    :build_command => "buildCommand",
    :port => "port",
    :runtime_environment_secrets => "runtimeEnvironmentSecrets",
    :runtime_environment_variables => "runtimeEnvironmentVariables",
    :start_command => "startCommand",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



832
833
834
835
836
837
838
839
840
841
842
843
 
# File 'app_runner/cfn_service.rb', line 832

def to_jsii
  result = {}
  result.merge!({
    "runtime" => @runtime,
    "buildCommand" => @build_command,
    "port" => @port,
    "runtimeEnvironmentSecrets" => @runtime_environment_secrets,
    "runtimeEnvironmentVariables" => @runtime_environment_variables,
    "startCommand" => @start_command,
  })
  result.compact
end