Class: AWSCDK::AppRunner::CfnService::ImageConfigurationProperty

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

Overview

Describes the configuration that AWS App Runner uses to run an App Runner service using an image pulled from a source image repository.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(port: nil, runtime_environment_secrets: nil, runtime_environment_variables: nil, start_command: nil) ⇒ ImageConfigurationProperty

Returns a new instance of ImageConfigurationProperty.

Parameters:



1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
 
# File 'app_runner/cfn_service.rb', line 1104

def initialize(port: nil, runtime_environment_secrets: nil, runtime_environment_variables: nil, start_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

#port ⇒ String? (readonly)

The port that your application listens to in the container.

Default: 8080

Returns:

  • (String, nil)

See Also:



1121
1122
1123
 
# File 'app_runner/cfn_service.rb', line 1121

def port
  @port
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:



1131
1132
1133
 
# File 'app_runner/cfn_service.rb', line 1131

def runtime_environment_secrets
  @runtime_environment_secrets
end

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

Environment variables that are available to your running App Runner service.

An array of key-value pairs.

Returns:

See Also:



1138
1139
1140
 
# File 'app_runner/cfn_service.rb', line 1138

def runtime_environment_variables
  @runtime_environment_variables
end

#start_command ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



1145
1146
1147
 
# File 'app_runner/cfn_service.rb', line 1145

def start_command
  @start_command
end

Class Method Details

.jsii_properties ⇒ Object 



1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'app_runner/cfn_service.rb', line 1147

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

Instance Method Details

#to_jsii ⇒ Object 



1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
 
# File 'app_runner/cfn_service.rb', line 1156

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