Class: AWSCDK::QuickSight::CfnFolderProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_folder_props.rb

Overview

Properties for defining a CfnFolder.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(aws_account_id: nil, folder_id: nil, folder_type: nil, name: nil, parent_folder_arn: nil, permissions: nil, sharing_model: nil, tags: nil) ⇒ CfnFolderProps

Returns a new instance of CfnFolderProps.

Parameters:

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

    The ID for the AWS account where you want to create the folder.

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

    The ID of the folder.

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

    The type of folder it is.

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

    A display name for the folder.

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

    The Amazon Resource Name (ARN) for the folder.

  • permissions (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnFolder::ResourcePermissionProperty>, nil) (defaults to: nil) —

    A structure that describes the principals and the resource-level permissions of a folder.

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

    The sharing scope of the folder.

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

    A list of tags for the folders that you want to apply overrides to.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'quick_sight/cfn_folder_props.rb', line 17

def initialize(aws_account_id: nil, folder_id: nil, folder_type: nil, name: nil, parent_folder_arn: nil, permissions: nil, sharing_model: nil, tags: nil)
  @aws_account_id = 
  Jsii::Type.check_type(@aws_account_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "awsAccountId") unless @aws_account_id.nil?
  @folder_id = folder_id
  Jsii::Type.check_type(@folder_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "folderId") unless @folder_id.nil?
  @folder_type = folder_type
  Jsii::Type.check_type(@folder_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "folderType") unless @folder_type.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @parent_folder_arn = parent_folder_arn
  Jsii::Type.check_type(@parent_folder_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parentFolderArn") unless @parent_folder_arn.nil?
  @permissions = permissions
  Jsii::Type.check_type(@permissions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5Gb2xkZXIuUmVzb3VyY2VQZXJtaXNzaW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "permissions") unless @permissions.nil?
  @sharing_model = sharing_model
  Jsii::Type.check_type(@sharing_model, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sharingModel") unless @sharing_model.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

#aws_account_id ⇒ String? (readonly)

The ID for the AWS account where you want to create the folder.

Returns:

  • (String, nil)

See Also:



40
41
42
 
# File 'quick_sight/cfn_folder_props.rb', line 40

def 
  @aws_account_id
end

#folder_id ⇒ String? (readonly)

The ID of the folder.

Returns:

  • (String, nil)

See Also:



45
46
47
 
# File 'quick_sight/cfn_folder_props.rb', line 45

def folder_id
  @folder_id
end

#folder_type ⇒ String? (readonly)

The type of folder it is.

Returns:

  • (String, nil)

See Also:



50
51
52
 
# File 'quick_sight/cfn_folder_props.rb', line 50

def folder_type
  @folder_type
end

#name ⇒ String? (readonly)

A display name for the folder.

Returns:

  • (String, nil)

See Also:



55
56
57
 
# File 'quick_sight/cfn_folder_props.rb', line 55

def name
  @name
end

#parent_folder_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) for the folder.

Returns:

  • (String, nil)

See Also:



60
61
62
 
# File 'quick_sight/cfn_folder_props.rb', line 60

def parent_folder_arn
  @parent_folder_arn
end

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

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions .

Returns:

See Also:



67
68
69
 
# File 'quick_sight/cfn_folder_props.rb', line 67

def permissions
  @permissions
end

#sharing_model ⇒ String? (readonly)

The sharing scope of the folder.

Returns:

  • (String, nil)

See Also:



72
73
74
 
# File 'quick_sight/cfn_folder_props.rb', line 72

def sharing_model
  @sharing_model
end

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

A list of tags for the folders that you want to apply overrides to.

Returns:

See Also:



77
78
79
 
# File 'quick_sight/cfn_folder_props.rb', line 77

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'quick_sight/cfn_folder_props.rb', line 79

def self.jsii_properties
  {
    :aws_account_id => "awsAccountId",
    :folder_id => "folderId",
    :folder_type => "folderType",
    :name => "name",
    :parent_folder_arn => "parentFolderArn",
    :permissions => "permissions",
    :sharing_model => "sharingModel",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'quick_sight/cfn_folder_props.rb', line 92

def to_jsii
  result = {}
  result.merge!({
    "awsAccountId" => @aws_account_id,
    "folderId" => @folder_id,
    "folderType" => @folder_type,
    "name" => @name,
    "parentFolderArn" => @parent_folder_arn,
    "permissions" => @permissions,
    "sharingModel" => @sharing_model,
    "tags" => @tags,
  })
  result.compact
end