Class: AWSCDK::QuickSight::CfnTemplateProps

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

Overview

Properties for defining a CfnTemplate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(aws_account_id:, template_id:, definition: nil, name: nil, permissions: nil, source_entity: nil, tags: nil, validation_strategy: nil, version_description: nil) ⇒ CfnTemplateProps

Returns a new instance of CfnTemplateProps.

Parameters:



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

def initialize(aws_account_id:, template_id:, definition: nil, name: nil, permissions: nil, source_entity: nil, tags: nil, validation_strategy: nil, version_description: nil)
  @aws_account_id = 
  Jsii::Type.check_type(@aws_account_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "awsAccountId")
  @template_id = template_id
  Jsii::Type.check_type(@template_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "templateId")
  @definition = definition.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::TemplateVersionDefinitionProperty.new(**definition.transform_keys(&:to_sym)) : definition
  Jsii::Type.check_type(@definition, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRlbXBsYXRlVmVyc2lvbkRlZmluaXRpb25Qcm9wZXJ0eSJ9XX19")), "definition") unless @definition.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @permissions = permissions
  Jsii::Type.check_type(@permissions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5SZXNvdXJjZVBlcm1pc3Npb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "permissions") unless @permissions.nil?
  @source_entity = source_entity.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::TemplateSourceEntityProperty.new(**source_entity.transform_keys(&:to_sym)) : source_entity
  Jsii::Type.check_type(@source_entity, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRlbXBsYXRlU291cmNlRW50aXR5UHJvcGVydHkifV19fQ==")), "sourceEntity") unless @source_entity.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?
  @validation_strategy = validation_strategy.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ValidationStrategyProperty.new(**validation_strategy.transform_keys(&:to_sym)) : validation_strategy
  Jsii::Type.check_type(@validation_strategy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlZhbGlkYXRpb25TdHJhdGVneVByb3BlcnR5In1dfX0=")), "validationStrategy") unless @validation_strategy.nil?
  @version_description = version_description
  Jsii::Type.check_type(@version_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "versionDescription") unless @version_description.nil?
end

Instance Attribute Details

#aws_account_id ⇒ String (readonly)

The ID for the AWS account that the group is in.

You use the ID for the AWS account that contains your Amazon Quick Sight account.

Returns:

  • (String)

See Also:



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

def 
  @aws_account_id
end

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

Returns:

See Also:



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

def definition
  @definition
end

#name ⇒ String? (readonly)

A display name for the template.

Returns:

  • (String, nil)

See Also:



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

def name
  @name
end

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

A list of resource permissions to be set on the template.

Returns:

See Also:



65
66
67
 
# File 'quick_sight/cfn_template_props.rb', line 65

def permissions
  @permissions
end

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

The entity that you are using as a source when you create the template.

In SourceEntity , you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate , specify the ARN of the source template. For SourceAnalysis , specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS account and any Quick Sight-supported AWS Region .

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Returns:

See Also:



76
77
78
 
# File 'quick_sight/cfn_template_props.rb', line 76

def source_entity
  @source_entity
end

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

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Returns:

See Also:



81
82
83
 
# File 'quick_sight/cfn_template_props.rb', line 81

def tags
  @tags
end

#template_id ⇒ String (readonly)

An ID for the template that you want to create.

This template is unique per AWS Region ; in each AWS account.

Returns:

  • (String)

See Also:



52
53
54
 
# File 'quick_sight/cfn_template_props.rb', line 52

def template_id
  @template_id
end

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

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

When you set this value to LENIENT , validation is skipped for specific errors.

Returns:

See Also:



88
89
90
 
# File 'quick_sight/cfn_template_props.rb', line 88

def validation_strategy
  @validation_strategy
end

#version_description ⇒ String? (readonly)

A description of the current template version being created.

This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.

Returns:

  • (String, nil)

See Also:



95
96
97
 
# File 'quick_sight/cfn_template_props.rb', line 95

def version_description
  @version_description
end

Class Method Details

.jsii_properties ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'quick_sight/cfn_template_props.rb', line 97

def self.jsii_properties
  {
    :aws_account_id => "awsAccountId",
    :template_id => "templateId",
    :definition => "definition",
    :name => "name",
    :permissions => "permissions",
    :source_entity => "sourceEntity",
    :tags => "tags",
    :validation_strategy => "validationStrategy",
    :version_description => "versionDescription",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'quick_sight/cfn_template_props.rb', line 111

def to_jsii
  result = {}
  result.merge!({
    "awsAccountId" => @aws_account_id,
    "templateId" => @template_id,
    "definition" => @definition,
    "name" => @name,
    "permissions" => @permissions,
    "sourceEntity" => @source_entity,
    "tags" => @tags,
    "validationStrategy" => @validation_strategy,
    "versionDescription" => @version_description,
  })
  result.compact
end