Class: Aws::AppRunner::Types::CreateServiceRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb

Overview

Note:

When making an API call, you may pass CreateServiceRequest data as a hash:

{
  service_name: "ServiceName", # required
  source_configuration: { # required
    code_repository: {
      repository_url: "String", # required
      source_code_version: { # required
        type: "BRANCH", # required, accepts BRANCH
        value: "String", # required
      },
      code_configuration: {
        configuration_source: "REPOSITORY", # required, accepts REPOSITORY, API
        code_configuration_values: {
          runtime: "PYTHON_3", # required, accepts PYTHON_3, NODEJS_12, NODEJS_14, CORRETTO_8, CORRETTO_11
          build_command: "BuildCommand",
          start_command: "StartCommand",
          port: "String",
          runtime_environment_variables: {
            "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
          },
        },
      },
    },
    image_repository: {
      image_identifier: "ImageIdentifier", # required
      image_configuration: {
        runtime_environment_variables: {
          "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
        },
        start_command: "StartCommand",
        port: "String",
      },
      image_repository_type: "ECR", # required, accepts ECR, ECR_PUBLIC
    },
    auto_deployments_enabled: false,
    authentication_configuration: {
      connection_arn: "AppRunnerResourceArn",
      access_role_arn: "RoleArn",
    },
  },
  instance_configuration: {
    cpu: "Cpu",
    memory: "Memory",
    instance_role_arn: "RoleArn",
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  encryption_configuration: {
    kms_key: "KmsKeyArn", # required
  },
  health_check_configuration: {
    protocol: "TCP", # accepts TCP, HTTP
    path: "HealthCheckPath",
    interval: 1,
    timeout: 1,
    healthy_threshold: 1,
    unhealthy_threshold: 1,
  },
  auto_scaling_configuration_arn: "AppRunnerResourceArn",
  network_configuration: {
    egress_configuration: {
      egress_type: "DEFAULT", # accepts DEFAULT, VPC
      vpc_connector_arn: "AppRunnerResourceArn",
    },
  },
  observability_configuration: {
    observability_enabled: false, # required
    observability_configuration_arn: "AppRunnerResourceArn",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_configuration_arnString

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)


849
850
851
852
853
854
855
856
857
858
859
860
861
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 849

class CreateServiceRequest < Struct.new(
  :service_name,
  :source_configuration,
  :instance_configuration,
  :tags,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_arn,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configurationTypes::EncryptionConfiguration

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 Amazon Web Services managed key.



849
850
851
852
853
854
855
856
857
858
859
860
861
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 849

class CreateServiceRequest < Struct.new(
  :service_name,
  :source_configuration,
  :instance_configuration,
  :tags,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_arn,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_configurationTypes::HealthCheckConfiguration

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



849
850
851
852
853
854
855
856
857
858
859
860
861
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 849

class CreateServiceRequest < Struct.new(
  :service_name,
  :source_configuration,
  :instance_configuration,
  :tags,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_arn,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#instance_configurationTypes::InstanceConfiguration

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



849
850
851
852
853
854
855
856
857
858
859
860
861
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 849

class CreateServiceRequest < Struct.new(
  :service_name,
  :source_configuration,
  :instance_configuration,
  :tags,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_arn,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#network_configurationTypes::NetworkConfiguration

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



849
850
851
852
853
854
855
856
857
858
859
860
861
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 849

class CreateServiceRequest < Struct.new(
  :service_name,
  :source_configuration,
  :instance_configuration,
  :tags,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_arn,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#observability_configurationTypes::ServiceObservabilityConfiguration

The observability configuration of your service.



849
850
851
852
853
854
855
856
857
858
859
860
861
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 849

class CreateServiceRequest < Struct.new(
  :service_name,
  :source_configuration,
  :instance_configuration,
  :tags,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_arn,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#service_nameString

A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.

Returns:

  • (String)


849
850
851
852
853
854
855
856
857
858
859
860
861
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 849

class CreateServiceRequest < Struct.new(
  :service_name,
  :source_configuration,
  :instance_configuration,
  :tags,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_arn,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#source_configurationTypes::SourceConfiguration

The source to deploy to the App Runner service. It can be a code or an image repository.



849
850
851
852
853
854
855
856
857
858
859
860
861
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 849

class CreateServiceRequest < Struct.new(
  :service_name,
  :source_configuration,
  :instance_configuration,
  :tags,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_arn,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.

Returns:



849
850
851
852
853
854
855
856
857
858
859
860
861
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 849

class CreateServiceRequest < Struct.new(
  :service_name,
  :source_configuration,
  :instance_configuration,
  :tags,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_arn,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end