Class: AWSCDK::AppMesh::CfnVirtualGatewayProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_mesh/cfn_virtual_gateway_props.rb

Overview

Properties for defining a CfnVirtualGateway.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(mesh_name:, spec:, mesh_owner: nil, tags: nil, virtual_gateway_name: nil) ⇒ CfnVirtualGatewayProps

Returns a new instance of CfnVirtualGatewayProps.

Parameters:

  • mesh_name (String) —

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

  • spec (AWSCDK::IResolvable, AWSCDK::AppMesh::CfnVirtualGateway::VirtualGatewaySpecProperty) —

    The specifications of the virtual gateway.

  • mesh_owner (String, nil) (defaults to: nil) —

    The AWS IAM account ID of the service mesh owner.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Optional metadata that you can apply to the virtual gateway to assist with categorization and organization.

  • virtual_gateway_name (String, nil) (defaults to: nil) —

    The name of the virtual gateway.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'app_mesh/cfn_virtual_gateway_props.rb', line 14

def initialize(mesh_name:, spec:, mesh_owner: nil, tags: nil, virtual_gateway_name: nil)
  @mesh_name = mesh_name
  Jsii::Type.check_type(@mesh_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "meshName")
  @spec = spec.is_a?(Hash) ? ::AWSCDK::AppMesh::CfnVirtualGateway::VirtualGatewaySpecProperty.new(**spec.transform_keys(&:to_sym)) : spec
  Jsii::Type.check_type(@spec, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBtZXNoLkNmblZpcnR1YWxHYXRld2F5LlZpcnR1YWxHYXRld2F5U3BlY1Byb3BlcnR5In1dfX0=")), "spec")
  @mesh_owner = mesh_owner
  Jsii::Type.check_type(@mesh_owner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "meshOwner") unless @mesh_owner.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?
  @virtual_gateway_name = virtual_gateway_name
  Jsii::Type.check_type(@virtual_gateway_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "virtualGatewayName") unless @virtual_gateway_name.nil?
end

Instance Attribute Details

#mesh_name ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



31
32
33
 
# File 'app_mesh/cfn_virtual_gateway_props.rb', line 31

def mesh_name
  @mesh_name
end

#mesh_owner ⇒ String? (readonly)

The AWS 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, nil)

See Also:



43
44
45
 
# File 'app_mesh/cfn_virtual_gateway_props.rb', line 43

def mesh_owner
  @mesh_owner
end

#spec ⇒ AWSCDK::IResolvable, AWSCDK::AppMesh::CfnVirtualGateway::VirtualGatewaySpecProperty (readonly)

The specifications of the virtual gateway.

Returns:

See Also:



36
37
38
 
# File 'app_mesh/cfn_virtual_gateway_props.rb', line 36

def spec
  @spec
end

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

Optional metadata that you can apply to the virtual gateway 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:

See Also:



50
51
52
 
# File 'app_mesh/cfn_virtual_gateway_props.rb', line 50

def tags
  @tags
end

#virtual_gateway_name ⇒ String? (readonly)

The name of the virtual gateway.

Returns:

  • (String, nil)

See Also:



55
56
57
 
# File 'app_mesh/cfn_virtual_gateway_props.rb', line 55

def virtual_gateway_name
  @virtual_gateway_name
end

Class Method Details

.jsii_properties ⇒ Object 



57
58
59
60
61
62
63
64
65
 
# File 'app_mesh/cfn_virtual_gateway_props.rb', line 57

def self.jsii_properties
  {
    :mesh_name => "meshName",
    :spec => "spec",
    :mesh_owner => "meshOwner",
    :tags => "tags",
    :virtual_gateway_name => "virtualGatewayName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
 
# File 'app_mesh/cfn_virtual_gateway_props.rb', line 67

def to_jsii
  result = {}
  result.merge!({
    "meshName" => @mesh_name,
    "spec" => @spec,
    "meshOwner" => @mesh_owner,
    "tags" => @tags,
    "virtualGatewayName" => @virtual_gateway_name,
  })
  result.compact
end