Class: AWSCDK::AppRunner::CfnServiceProps

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

Overview

Properties for defining a CfnService.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source_configuration:, auto_scaling_configuration_arn: nil, encryption_configuration: nil, health_check_configuration: nil, instance_configuration: nil, network_configuration: nil, observability_configuration: nil, service_name: nil, tags: nil) ⇒ CfnServiceProps

Returns a new instance of CfnServiceProps.

Parameters:



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'app_runner/cfn_service_props.rb', line 18

def initialize(source_configuration:, auto_scaling_configuration_arn: nil, encryption_configuration: nil, health_check_configuration: nil, instance_configuration: nil, network_configuration: nil, observability_configuration: nil, service_name: nil, tags: nil)
  @source_configuration = source_configuration.is_a?(Hash) ? ::AWSCDK::AppRunner::CfnService::SourceConfigurationProperty.new(**source_configuration.transform_keys(&:to_sym)) : source_configuration
  Jsii::Type.check_type(@source_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBydW5uZXIuQ2ZuU2VydmljZS5Tb3VyY2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "sourceConfiguration")
  @auto_scaling_configuration_arn = auto_scaling_configuration_arn
  Jsii::Type.check_type(@auto_scaling_configuration_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "autoScalingConfigurationArn") unless @auto_scaling_configuration_arn.nil?
  @encryption_configuration = encryption_configuration.is_a?(Hash) ? ::AWSCDK::AppRunner::CfnService::EncryptionConfigurationProperty.new(**encryption_configuration.transform_keys(&:to_sym)) : encryption_configuration
  Jsii::Type.check_type(@encryption_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBydW5uZXIuQ2ZuU2VydmljZS5FbmNyeXB0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "encryptionConfiguration") unless @encryption_configuration.nil?
  @health_check_configuration = health_check_configuration.is_a?(Hash) ? ::AWSCDK::AppRunner::CfnService::HealthCheckConfigurationProperty.new(**health_check_configuration.transform_keys(&:to_sym)) : health_check_configuration
  Jsii::Type.check_type(@health_check_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBydW5uZXIuQ2ZuU2VydmljZS5IZWFsdGhDaGVja0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "healthCheckConfiguration") unless @health_check_configuration.nil?
  @instance_configuration = instance_configuration.is_a?(Hash) ? ::AWSCDK::AppRunner::CfnService::InstanceConfigurationProperty.new(**instance_configuration.transform_keys(&:to_sym)) : instance_configuration
  Jsii::Type.check_type(@instance_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBydW5uZXIuQ2ZuU2VydmljZS5JbnN0YW5jZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "instanceConfiguration") unless @instance_configuration.nil?
  @network_configuration = network_configuration.is_a?(Hash) ? ::AWSCDK::AppRunner::CfnService::NetworkConfigurationProperty.new(**network_configuration.transform_keys(&:to_sym)) : network_configuration
  Jsii::Type.check_type(@network_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBydW5uZXIuQ2ZuU2VydmljZS5OZXR3b3JrQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "networkConfiguration") unless @network_configuration.nil?
  @observability_configuration = observability_configuration.is_a?(Hash) ? ::AWSCDK::AppRunner::CfnService::ServiceObservabilityConfigurationProperty.new(**observability_configuration.transform_keys(&:to_sym)) : observability_configuration
  Jsii::Type.check_type(@observability_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBydW5uZXIuQ2ZuU2VydmljZS5TZXJ2aWNlT2JzZXJ2YWJpbGl0eUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "observabilityConfiguration") unless @observability_configuration.nil?
  @service_name = service_name
  Jsii::Type.check_type(@service_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceName") unless @service_name.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#auto_scaling_configuration_arn ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



56
57
58
 
# File 'app_runner/cfn_service_props.rb', line 56

def auto_scaling_configuration_arn
  @auto_scaling_configuration_arn
end

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

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 .

Returns:

See Also:



63
64
65
 
# File 'app_runner/cfn_service_props.rb', line 63

def encryption_configuration
  @encryption_configuration
end

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

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

Returns:

See Also:



68
69
70
 
# File 'app_runner/cfn_service_props.rb', line 68

def health_check_configuration
  @health_check_configuration
end

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

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

Returns:

See Also:



73
74
75
 
# File 'app_runner/cfn_service_props.rb', line 73

def instance_configuration
  @instance_configuration
end

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

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

Returns:

See Also:



78
79
80
 
# File 'app_runner/cfn_service_props.rb', line 78

def network_configuration
  @network_configuration
end

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

The observability configuration of your service.

Returns:

See Also:



83
84
85
 
# File 'app_runner/cfn_service_props.rb', line 83

def observability_configuration
  @observability_configuration
end

#service_name ⇒ String? (readonly)

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, CloudFormation generates a name for your service.

Returns:

  • (String, nil)

See Also:



92
93
94
 
# File 'app_runner/cfn_service_props.rb', line 92

def service_name
  @service_name
end

#source_configuration ⇒ AWSCDK::IResolvable, AWSCDK::AppRunner::CfnService::SourceConfigurationProperty (readonly)

The source to deploy to the App Runner service.

It can be a code or an image repository.

Returns:

See Also:



45
46
47
 
# File 'app_runner/cfn_service_props.rb', line 45

def source_configuration
  @source_configuration
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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

A tag is a key-value pair.

Returns:

See Also:



99
100
101
 
# File 'app_runner/cfn_service_props.rb', line 99

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'app_runner/cfn_service_props.rb', line 101

def self.jsii_properties
  {
    :source_configuration => "sourceConfiguration",
    :auto_scaling_configuration_arn => "autoScalingConfigurationArn",
    :encryption_configuration => "encryptionConfiguration",
    :health_check_configuration => "healthCheckConfiguration",
    :instance_configuration => "instanceConfiguration",
    :network_configuration => "networkConfiguration",
    :observability_configuration => "observabilityConfiguration",
    :service_name => "serviceName",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'app_runner/cfn_service_props.rb', line 115

def to_jsii
  result = {}
  result.merge!({
    "sourceConfiguration" => @source_configuration,
    "autoScalingConfigurationArn" => @auto_scaling_configuration_arn,
    "encryptionConfiguration" => @encryption_configuration,
    "healthCheckConfiguration" => @health_check_configuration,
    "instanceConfiguration" => @instance_configuration,
    "networkConfiguration" => @network_configuration,
    "observabilityConfiguration" => @observability_configuration,
    "serviceName" => @service_name,
    "tags" => @tags,
  })
  result.compact
end