Class: AWSCDK::AppMesh::CfnGatewayRouteProps

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

Overview

Properties for defining a CfnGatewayRoute.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CfnGatewayRouteProps.

Parameters:

  • mesh_name (String) —

    The name of the service mesh that the resource resides in.

  • spec (AWSCDK::IResolvable, AWSCDK::AppMesh::CfnGatewayRoute::GatewayRouteSpecProperty) —

    The specifications of the gateway route.

  • virtual_gateway_name (String) —

    The virtual gateway that the gateway route is associated with.

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

    The name of the gateway route.

  • 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 gateway route to assist with categorization and organization.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'app_mesh/cfn_gateway_route_props.rb', line 15

def initialize(mesh_name:, spec:, virtual_gateway_name:, gateway_route_name: nil, mesh_owner: nil, tags: 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::CfnGatewayRoute::GatewayRouteSpecProperty.new(**spec.transform_keys(&:to_sym)) : spec
  Jsii::Type.check_type(@spec, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBtZXNoLkNmbkdhdGV3YXlSb3V0ZS5HYXRld2F5Um91dGVTcGVjUHJvcGVydHkifV19fQ==")), "spec")
  @virtual_gateway_name = virtual_gateway_name
  Jsii::Type.check_type(@virtual_gateway_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "virtualGatewayName")
  @gateway_route_name = gateway_route_name
  Jsii::Type.check_type(@gateway_route_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gatewayRouteName") unless @gateway_route_name.nil?
  @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?
end

Instance Attribute Details

#gateway_route_name ⇒ String? (readonly)

The name of the gateway route.

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'app_mesh/cfn_gateway_route_props.rb', line 49

def gateway_route_name
  @gateway_route_name
end

#mesh_name ⇒ String (readonly)

The name of the service mesh that the resource resides in.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'app_mesh/cfn_gateway_route_props.rb', line 34

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:



56
57
58
 
# File 'app_mesh/cfn_gateway_route_props.rb', line 56

def mesh_owner
  @mesh_owner
end

#spec ⇒ AWSCDK::IResolvable, AWSCDK::AppMesh::CfnGatewayRoute::GatewayRouteSpecProperty (readonly)

The specifications of the gateway route.

Returns:

See Also:



39
40
41
 
# File 'app_mesh/cfn_gateway_route_props.rb', line 39

def spec
  @spec
end

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

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



63
64
65
 
# File 'app_mesh/cfn_gateway_route_props.rb', line 63

def tags
  @tags
end

#virtual_gateway_name ⇒ String (readonly)

The virtual gateway that the gateway route is associated with.

Returns:

  • (String)

See Also:



44
45
46
 
# File 'app_mesh/cfn_gateway_route_props.rb', line 44

def virtual_gateway_name
  @virtual_gateway_name
end

Class Method Details

.jsii_properties ⇒ Object 



65
66
67
68
69
70
71
72
73
74
 
# File 'app_mesh/cfn_gateway_route_props.rb', line 65

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

Instance Method Details

#to_jsii ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'app_mesh/cfn_gateway_route_props.rb', line 76

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