Class: AWSCDK::IdentityStore::CfnGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
identity_store/cfn_group_props.rb

Overview

Properties for defining a CfnGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(display_name:, identity_store_id:, description: nil) ⇒ CfnGroupProps

Returns a new instance of CfnGroupProps.

Parameters:

  • display_name (String) —

    The display name value for the group.

  • identity_store_id (String) —

    The globally unique identifier for the identity store.

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

    A string containing the description of the group.



12
13
14
15
16
17
18
19
 
# File 'identity_store/cfn_group_props.rb', line 12

def initialize(display_name:, identity_store_id:, description: nil)
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName")
  @identity_store_id = identity_store_id
  Jsii::Type.check_type(@identity_store_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityStoreId")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

A string containing the description of the group.

Returns:

  • (String, nil)

See Also:



39
40
41
 
# File 'identity_store/cfn_group_props.rb', line 39

def description
  @description
end

#display_name ⇒ String (readonly)

The display name value for the group.

The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.

Prefix search supports a maximum of 1,000 characters for the string.

Returns:

  • (String)

See Also:



29
30
31
 
# File 'identity_store/cfn_group_props.rb', line 29

def display_name
  @display_name
end

#identity_store_id ⇒ String (readonly)

The globally unique identifier for the identity store.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'identity_store/cfn_group_props.rb', line 34

def identity_store_id
  @identity_store_id
end

Class Method Details

.jsii_properties ⇒ Object 



41
42
43
44
45
46
47
 
# File 'identity_store/cfn_group_props.rb', line 41

def self.jsii_properties
  {
    :display_name => "displayName",
    :identity_store_id => "identityStoreId",
    :description => "description",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



49
50
51
52
53
54
55
56
57
 
# File 'identity_store/cfn_group_props.rb', line 49

def to_jsii
  result = {}
  result.merge!({
    "displayName" => @display_name,
    "identityStoreId" => @identity_store_id,
    "description" => @description,
  })
  result.compact
end