Class: AWSCDK::OpenSearchServerless::CfnCollectionGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
open_search_serverless/cfn_collection_group_props.rb

Overview

Properties for defining a CfnCollectionGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, standby_replicas:, capacity_limits: nil, description: nil, generation: nil, tags: nil) ⇒ CfnCollectionGroupProps

Returns a new instance of CfnCollectionGroupProps.

Parameters:

  • name (String) —

    The name of the collection group.

  • standby_replicas (String) —

    Indicates whether standby replicas are used for the collection group.

  • capacity_limits (AWSCDK::IResolvable, AWSCDK::OpenSearchServerless::CfnCollectionGroup::CapacityLimitsProperty, nil) (defaults to: nil)
  • description (String, nil) (defaults to: nil) —

    The description of the collection group.

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

    The generation of Amazon OpenSearch Serverless for the collection group.

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

    An array of key-value pairs to apply to this resource.



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

def initialize(name:, standby_replicas:, capacity_limits: nil, description: nil, generation: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @standby_replicas = standby_replicas
  Jsii::Type.check_type(@standby_replicas, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "standbyReplicas")
  @capacity_limits = capacity_limits.is_a?(Hash) ? ::AWSCDK::OpenSearchServerless::CfnCollectionGroup::CapacityLimitsProperty.new(**capacity_limits.transform_keys(&:to_sym)) : capacity_limits
  Jsii::Type.check_type(@capacity_limits, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmVybGVzcy5DZm5Db2xsZWN0aW9uR3JvdXAuQ2FwYWNpdHlMaW1pdHNQcm9wZXJ0eSJ9XX19")), "capacityLimits") unless @capacity_limits.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @generation = generation
  Jsii::Type.check_type(@generation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "generation") unless @generation.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

#capacity_limits ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



42
43
44
 
# File 'open_search_serverless/cfn_collection_group_props.rb', line 42

def capacity_limits
  @capacity_limits
end

#description ⇒ String? (readonly)

The description of the collection group.

Returns:

  • (String, nil)

See Also:



47
48
49
 
# File 'open_search_serverless/cfn_collection_group_props.rb', line 47

def description
  @description
end

#generation ⇒ String? (readonly)

The generation of Amazon OpenSearch Serverless for the collection group.

Valid values are CLASSIC and NEXTGEN.

Returns:

  • (String, nil)

See Also:



54
55
56
 
# File 'open_search_serverless/cfn_collection_group_props.rb', line 54

def generation
  @generation
end

#name ⇒ String (readonly)

The name of the collection group.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'open_search_serverless/cfn_collection_group_props.rb', line 34

def name
  @name
end

#standby_replicas ⇒ String (readonly)

Indicates whether standby replicas are used for the collection group.

Returns:

  • (String)

See Also:



39
40
41
 
# File 'open_search_serverless/cfn_collection_group_props.rb', line 39

def standby_replicas
  @standby_replicas
end

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

An array of key-value pairs to apply to this resource.

Returns:

See Also:



59
60
61
 
# File 'open_search_serverless/cfn_collection_group_props.rb', line 59

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



61
62
63
64
65
66
67
68
69
70
 
# File 'open_search_serverless/cfn_collection_group_props.rb', line 61

def self.jsii_properties
  {
    :name => "name",
    :standby_replicas => "standbyReplicas",
    :capacity_limits => "capacityLimits",
    :description => "description",
    :generation => "generation",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'open_search_serverless/cfn_collection_group_props.rb', line 72

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "standbyReplicas" => @standby_replicas,
    "capacityLimits" => @capacity_limits,
    "description" => @description,
    "generation" => @generation,
    "tags" => @tags,
  })
  result.compact
end