Class: Aws::AppMesh::Types::UpdateVirtualGatewayInput

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 UpdateVirtualGatewayInput data as a hash:

{
  client_token: "String",
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  spec: { # required
    backend_defaults: {
      client_policy: {
        tls: {
          certificate: {
            file: {
              certificate_chain: "FilePath", # required
              private_key: "FilePath", # required
            },
            sds: {
              secret_name: "VirtualGatewaySdsSecretName", # required
            },
          },
          enforce: false,
          ports: [1],
          validation: { # required
            subject_alternative_names: {
              match: { # required
                exact: ["SubjectAlternativeName"], # required
              },
            },
            trust: { # required
              acm: {
                certificate_authority_arns: ["Arn"], # required
              },
              file: {
                certificate_chain: "FilePath", # required
              },
              sds: {
                secret_name: "VirtualGatewaySdsSecretName", # required
              },
            },
          },
        },
      },
    },
    listeners: [ # required
      {
        connection_pool: {
          grpc: {
            max_requests: 1, # required
          },
          http: {
            max_connections: 1, # required
            max_pending_requests: 1,
          },
          http2: {
            max_requests: 1, # required
          },
        },
        health_check: {
          healthy_threshold: 1, # required
          interval_millis: 1, # required
          path: "String",
          port: 1,
          protocol: "http", # required, accepts http, http2, grpc
          timeout_millis: 1, # required
          unhealthy_threshold: 1, # required
        },
        port_mapping: { # required
          port: 1, # required
          protocol: "http", # required, accepts http, http2, grpc
        },
        tls: {
          certificate: { # required
            acm: {
              certificate_arn: "Arn", # required
            },
            file: {
              certificate_chain: "FilePath", # required
              private_key: "FilePath", # required
            },
            sds: {
              secret_name: "VirtualGatewaySdsSecretName", # required
            },
          },
          mode: "STRICT", # required, accepts STRICT, PERMISSIVE, DISABLED
          validation: {
            subject_alternative_names: {
              match: { # required
                exact: ["SubjectAlternativeName"], # required
              },
            },
            trust: { # required
              file: {
                certificate_chain: "FilePath", # required
              },
              sds: {
                secret_name: "VirtualGatewaySdsSecretName", # required
              },
            },
          },
        },
      },
    ],
    logging: {
      access_log: {
        file: {
          path: "FilePath", # required
        },
      },
    },
  },
  virtual_gateway_name: "ResourceName", # required
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

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) 

7611
7612
7613
7614
7615
7616
7617
7618
7619
 
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 7611

class UpdateVirtualGatewayInput < Struct.new(
  :client_token,
  :mesh_name,
  :mesh_owner,
  :spec,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end

#mesh_name ⇒ String

The name of the service mesh that the virtual gateway resides in.

Returns:

  • (String) 

7611
7612
7613
7614
7615
7616
7617
7618
7619
 
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 7611

class UpdateVirtualGatewayInput < Struct.new(
  :client_token,
  :mesh_name,
  :mesh_owner,
  :spec,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end

#mesh_owner ⇒ String

The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

Returns:

  • (String) 

7611
7612
7613
7614
7615
7616
7617
7618
7619
 
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 7611

class UpdateVirtualGatewayInput < Struct.new(
  :client_token,
  :mesh_name,
  :mesh_owner,
  :spec,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end

#spec ⇒ Types::VirtualGatewaySpec

The new virtual gateway specification to apply. This overwrites the existing data.

Returns:


7611
7612
7613
7614
7615
7616
7617
7618
7619
 
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 7611

class UpdateVirtualGatewayInput < Struct.new(
  :client_token,
  :mesh_name,
  :mesh_owner,
  :spec,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_gateway_name ⇒ String

The name of the virtual gateway to update.

Returns:

  • (String) 

7611
7612
7613
7614
7615
7616
7617
7618
7619
 
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 7611

class UpdateVirtualGatewayInput < Struct.new(
  :client_token,
  :mesh_name,
  :mesh_owner,
  :spec,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end