You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AppMesh::Types::CreateVirtualNodeInput

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

Overview

Note:

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

{
  client_token: "String",
  mesh_name: "ResourceName", # required
  spec: { # required
    backends: [
      {
        virtual_service: {
          virtual_service_name: "ServiceName", # required
        },
      },
    ],
    listeners: [
      {
        health_check: {
          healthy_threshold: 1, # required
          interval_millis: 1, # required
          path: "String",
          port: 1,
          protocol: "http", # required, accepts http, tcp
          timeout_millis: 1, # required
          unhealthy_threshold: 1, # required
        },
        port_mapping: { # required
          port: 1, # required
          protocol: "http", # required, accepts http, tcp
        },
      },
    ],
    logging: {
      access_log: {
        file: {
          path: "FilePath", # required
        },
      },
    },
    service_discovery: {
      aws_cloud_map: {
        attributes: [
          {
            key: "AwsCloudMapInstanceAttributeKey", # required
            value: "AwsCloudMapInstanceAttributeValue", # required
          },
        ],
        namespace_name: "AwsCloudMapName", # required
        service_name: "AwsCloudMapName", # required
      },
      dns: {
        hostname: "Hostname", # required
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  virtual_node_name: "ResourceName", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


2953
2954
2955
2956
2957
2958
2959
2960
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 2953

class CreateVirtualNodeInput < Struct.new(
  :client_token,
  :mesh_name,
  :spec,
  :tags,
  :virtual_node_name)
  include Aws::Structure
end

#mesh_nameString

The name of the service mesh to create the virtual node in.

Returns:

  • (String)


2953
2954
2955
2956
2957
2958
2959
2960
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 2953

class CreateVirtualNodeInput < Struct.new(
  :client_token,
  :mesh_name,
  :spec,
  :tags,
  :virtual_node_name)
  include Aws::Structure
end

#specTypes::VirtualNodeSpec

The virtual node specification to apply.



2953
2954
2955
2956
2957
2958
2959
2960
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 2953

class CreateVirtualNodeInput < Struct.new(
  :client_token,
  :mesh_name,
  :spec,
  :tags,
  :virtual_node_name)
  include Aws::Structure
end

#tagsArray<Types::TagRef>

Optional metadata that you can apply to the virtual node to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Returns:



2953
2954
2955
2956
2957
2958
2959
2960
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 2953

class CreateVirtualNodeInput < Struct.new(
  :client_token,
  :mesh_name,
  :spec,
  :tags,
  :virtual_node_name)
  include Aws::Structure
end

#virtual_node_nameString

The name to use for the virtual node.

Returns:

  • (String)


2953
2954
2955
2956
2957
2958
2959
2960
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 2953

class CreateVirtualNodeInput < Struct.new(
  :client_token,
  :mesh_name,
  :spec,
  :tags,
  :virtual_node_name)
  include Aws::Structure
end