Class: AWSCDK::Grafana::CfnWorkspace

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSGrafana::IWorkspaceRef
Defined in:
grafana/cfn_workspace.rb

Overview

Specifies a workspace .

In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnWorkspace

Create a new AWS::Grafana::Workspace.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Grafana::CfnWorkspaceProps) —

    Resource properties.



19
20
21
22
23
24
25
 
# File 'grafana/cfn_workspace.rb', line 19

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Grafana::CfnWorkspaceProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ3JhZmFuYS5DZm5Xb3Jrc3BhY2VQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


195
196
197
 
# File 'grafana/cfn_workspace.rb', line 195

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_grafana.CfnWorkspace", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_workspace(x) ⇒ Boolean

Checks whether the given object is a CfnWorkspace.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


97
98
99
100
 
# File 'grafana/cfn_workspace.rb', line 97

def self.is_cfn_workspace(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_grafana.CfnWorkspace", "isCfnWorkspace", [x])
end

.jsii_overridable_methods ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'grafana/cfn_workspace.rb', line 27

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_creation_timestamp => { kind: :property, name: "attrCreationTimestamp", is_optional: false },
    :attr_endpoint => { kind: :property, name: "attrEndpoint", is_optional: false },
    :attr_grafana_version => { kind: :property, name: "attrGrafanaVersion", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_modification_timestamp => { kind: :property, name: "attrModificationTimestamp", is_optional: false },
    :attr_saml_configuration_status => { kind: :property, name: "attrSamlConfigurationStatus", is_optional: false },
    :attr_sso_client_id => { kind: :property, name: "attrSsoClientId", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :workspace_ref => { kind: :property, name: "workspaceRef", is_optional: false },
    :account_access_type => { kind: :property, name: "accountAccessType", is_optional: false },
    :authentication_providers => { kind: :property, name: "authenticationProviders", is_optional: false },
    :permission_type => { kind: :property, name: "permissionType", is_optional: false },
    :client_token => { kind: :property, name: "clientToken", is_optional: true },
    :data_sources => { kind: :property, name: "dataSources", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :grafana_version => { kind: :property, name: "grafanaVersion", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :network_access_control => { kind: :property, name: "networkAccessControl", is_optional: true },
    :notification_destinations => { kind: :property, name: "notificationDestinations", is_optional: true },
    :organizational_units => { kind: :property, name: "organizationalUnits", is_optional: true },
    :organization_role_name => { kind: :property, name: "organizationRoleName", is_optional: true },
    :plugin_admin_enabled => { kind: :property, name: "pluginAdminEnabled", is_optional: true },
    :role_arn => { kind: :property, name: "roleArn", is_optional: true },
    :saml_configuration => { kind: :property, name: "samlConfiguration", is_optional: true },
    :stack_set_name => { kind: :property, name: "stackSetName", is_optional: true },
    :vpc_configuration => { kind: :property, name: "vpcConfiguration", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#account_access_type ⇒ String

Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization.

Returns:

  • (String) 


285
286
287
 
# File 'grafana/cfn_workspace.rb', line 285

def ()
  jsii_get_property("accountAccessType")
end

#account_access_type=(value) ⇒ Object 



289
290
291
292
 
# File 'grafana/cfn_workspace.rb', line 289

def (value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accountAccessType")
  jsii_set_property("accountAccessType", value)
end

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



525
526
527
528
 
# File 'grafana/cfn_workspace.rb', line 525

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



537
538
539
540
 
# File 'grafana/cfn_workspace.rb', line 537

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



547
548
549
550
 
# File 'grafana/cfn_workspace.rb', line 547

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



558
559
560
561
562
 
# File 'grafana/cfn_workspace.rb', line 558

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


615
616
617
618
619
 
# File 'grafana/cfn_workspace.rb', line 615

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



625
626
627
628
 
# File 'grafana/cfn_workspace.rb', line 625

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



637
638
639
640
641
 
# File 'grafana/cfn_workspace.rb', line 637

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



650
651
652
653
 
# File 'grafana/cfn_workspace.rb', line 650

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



672
673
674
675
676
677
 
# File 'grafana/cfn_workspace.rb', line 672

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_creation_timestamp ⇒ String

The date that the workspace was created.

Type: Timestamp

Returns:

  • (String) 


204
205
206
 
# File 'grafana/cfn_workspace.rb', line 204

def attr_creation_timestamp()
  jsii_get_property("attrCreationTimestamp")
end

#attr_endpoint ⇒ String

The URL that users can use to access the Grafana console in the workspace.

Type: String

Returns:

  • (String) 


213
214
215
 
# File 'grafana/cfn_workspace.rb', line 213

def attr_endpoint()
  jsii_get_property("attrEndpoint")
end

#attr_grafana_version ⇒ String

Specifies the version of Grafana supported by this workspace.

Type: String

Returns:

  • (String) 


222
223
224
 
# File 'grafana/cfn_workspace.rb', line 222

def attr_grafana_version()
  jsii_get_property("attrGrafanaVersion")
end

#attr_id ⇒ String

The unique ID of this workspace.

Type: String

Returns:

  • (String) 


231
232
233
 
# File 'grafana/cfn_workspace.rb', line 231

def attr_id()
  jsii_get_property("attrId")
end

#attr_modification_timestamp ⇒ String

The most recent date that the workspace was modified.

Type: Timestamp

Returns:

  • (String) 


240
241
242
 
# File 'grafana/cfn_workspace.rb', line 240

def attr_modification_timestamp()
  jsii_get_property("attrModificationTimestamp")
end

#attr_saml_configuration_status ⇒ String

Specifies whether the workspace's SAML configuration is complete.

Valid values: CONFIGURED | NOT_CONFIGURED

Type: String

Returns:

  • (String) 


251
252
253
 
# File 'grafana/cfn_workspace.rb', line 251

def attr_saml_configuration_status()
  jsii_get_property("attrSamlConfigurationStatus")
end

#attr_sso_client_id ⇒ String

The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana .

Type: String

Returns:

  • (String) 


260
261
262
 
# File 'grafana/cfn_workspace.rb', line 260

def attr_sso_client_id()
  jsii_get_property("attrSsoClientId")
end

#attr_status ⇒ String

The current status of the workspace.

Valid values: ACTIVE | CREATING | DELETING | FAILED | UPDATING | UPGRADING | DELETION_FAILED | CREATION_FAILED | UPDATE_FAILED | UPGRADE_FAILED | LICENSE_REMOVAL_FAILED

Type: String

Returns:

  • (String) 


271
272
273
 
# File 'grafana/cfn_workspace.rb', line 271

def attr_status()
  jsii_get_property("attrStatus")
end

#authentication_providers ⇒ Array<String>

Specifies whether this workspace uses SAML 2.0, SSOlong , or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana .

Returns:

  • (Array<String>) 


297
298
299
 
# File 'grafana/cfn_workspace.rb', line 297

def authentication_providers()
  jsii_get_property("authenticationProviders")
end

#authentication_providers=(value) ⇒ Object 



301
302
303
304
 
# File 'grafana/cfn_workspace.rb', line 301

def authentication_providers=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "authenticationProviders")
  jsii_set_property("authenticationProviders", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



148
149
150
 
# File 'grafana/cfn_workspace.rb', line 148

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


153
154
155
 
# File 'grafana/cfn_workspace.rb', line 153

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


681
682
683
684
 
# File 'grafana/cfn_workspace.rb', line 681

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


158
159
160
 
# File 'grafana/cfn_workspace.rb', line 158

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


165
166
167
 
# File 'grafana/cfn_workspace.rb', line 165

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#client_token ⇒ String?

A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

Returns:

  • (String, nil) 


321
322
323
 
# File 'grafana/cfn_workspace.rb', line 321

def client_token()
  jsii_get_property("clientToken")
end

#client_token=(value) ⇒ Object 



325
326
327
328
 
# File 'grafana/cfn_workspace.rb', line 325

def client_token=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientToken") unless value.nil?
  jsii_set_property("clientToken", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


110
111
112
 
# File 'grafana/cfn_workspace.rb', line 110

def creation_stack()
  jsii_get_property("creationStack")
end

#data_sources ⇒ Array<String>?

Specifies the AWS data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

Returns:

  • (Array<String>, nil) 


333
334
335
 
# File 'grafana/cfn_workspace.rb', line 333

def data_sources()
  jsii_get_property("dataSources")
end

#data_sources=(value) ⇒ Object 



337
338
339
340
 
# File 'grafana/cfn_workspace.rb', line 337

def data_sources=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "dataSources") unless value.nil?
  jsii_set_property("dataSources", value)
end

#description ⇒ String?

The user-defined description of the workspace.

Returns:

  • (String, nil) 


345
346
347
 
# File 'grafana/cfn_workspace.rb', line 345

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



349
350
351
352
 
# File 'grafana/cfn_workspace.rb', line 349

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



170
171
172
 
# File 'grafana/cfn_workspace.rb', line 170

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



694
695
696
697
698
 
# File 'grafana/cfn_workspace.rb', line 694

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



705
706
707
708
 
# File 'grafana/cfn_workspace.rb', line 705

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#grafana_version ⇒ String?

Specifies the version of Grafana to support in the workspace.

Returns:

  • (String, nil) 


357
358
359
 
# File 'grafana/cfn_workspace.rb', line 357

def grafana_version()
  jsii_get_property("grafanaVersion")
end

#grafana_version=(value) ⇒ Object 



361
362
363
364
 
# File 'grafana/cfn_workspace.rb', line 361

def grafana_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "grafanaVersion") unless value.nil?
  jsii_set_property("grafanaVersion", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



775
776
777
778
 
# File 'grafana/cfn_workspace.rb', line 775

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


122
123
124
 
# File 'grafana/cfn_workspace.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name of the workspace.

Returns:

  • (String, nil) 


369
370
371
 
# File 'grafana/cfn_workspace.rb', line 369

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



373
374
375
376
 
# File 'grafana/cfn_workspace.rb', line 373

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#network_access_control ⇒ AWSCDK::IResolvable, ...

The configuration settings for network access to your workspace.

Returns:



381
382
383
 
# File 'grafana/cfn_workspace.rb', line 381

def network_access_control()
  jsii_get_property("networkAccessControl")
end

#network_access_control=(value) ⇒ Object 



385
386
387
388
389
 
# File 'grafana/cfn_workspace.rb', line 385

def network_access_control=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Grafana::CfnWorkspace::NetworkAccessControlProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ncmFmYW5hLkNmbldvcmtzcGFjZS5OZXR3b3JrQWNjZXNzQ29udHJvbFByb3BlcnR5In1dfX0=")), "networkAccessControl") unless value.nil?
  jsii_set_property("networkAccessControl", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


105
106
107
 
# File 'grafana/cfn_workspace.rb', line 105

def node()
  jsii_get_property("node")
end

#notification_destinations ⇒ Array<String>?

The AWS notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.

Returns:

  • (Array<String>, nil) 


394
395
396
 
# File 'grafana/cfn_workspace.rb', line 394

def notification_destinations()
  jsii_get_property("notificationDestinations")
end

#notification_destinations=(value) ⇒ Object 



398
399
400
401
 
# File 'grafana/cfn_workspace.rb', line 398

def notification_destinations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "notificationDestinations") unless value.nil?
  jsii_set_property("notificationDestinations", value)
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



716
717
718
 
# File 'grafana/cfn_workspace.rb', line 716

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



723
724
725
 
# File 'grafana/cfn_workspace.rb', line 723

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#organization_role_name ⇒ String?

The name of the IAM role that is used to access resources through Organizations.

Returns:

  • (String, nil) 


418
419
420
 
# File 'grafana/cfn_workspace.rb', line 418

def organization_role_name()
  jsii_get_property("organizationRoleName")
end

#organization_role_name=(value) ⇒ Object 



422
423
424
425
 
# File 'grafana/cfn_workspace.rb', line 422

def organization_role_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "organizationRoleName") unless value.nil?
  jsii_set_property("organizationRoleName", value)
end

#organizational_units ⇒ Array<String>?

Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.

Returns:

  • (Array<String>, nil) 


406
407
408
 
# File 'grafana/cfn_workspace.rb', line 406

def organizational_units()
  jsii_get_property("organizationalUnits")
end

#organizational_units=(value) ⇒ Object 



410
411
412
413
 
# File 'grafana/cfn_workspace.rb', line 410

def organizational_units=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "organizationalUnits") unless value.nil?
  jsii_set_property("organizationalUnits", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



516
517
518
519
 
# File 'grafana/cfn_workspace.rb', line 516

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#permission_type ⇒ String

If this is SERVICE_MANAGED , and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use AWS data sources and notification channels.

Returns:

  • (String) 


309
310
311
 
# File 'grafana/cfn_workspace.rb', line 309

def permission_type()
  jsii_get_property("permissionType")
end

#permission_type=(value) ⇒ Object 



313
314
315
316
 
# File 'grafana/cfn_workspace.rb', line 313

def permission_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "permissionType")
  jsii_set_property("permissionType", value)
end

#plugin_admin_enabled ⇒ Boolean, ...

Whether plugin administration is enabled in the workspace.

Returns:



430
431
432
 
# File 'grafana/cfn_workspace.rb', line 430

def plugin_admin_enabled()
  jsii_get_property("pluginAdminEnabled")
end

#plugin_admin_enabled=(value) ⇒ Object 



434
435
436
437
 
# File 'grafana/cfn_workspace.rb', line 434

def plugin_admin_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "pluginAdminEnabled") unless value.nil?
  jsii_set_property("pluginAdminEnabled", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


141
142
143
 
# File 'grafana/cfn_workspace.rb', line 141

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



734
735
736
737
 
# File 'grafana/cfn_workspace.rb', line 734

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


741
742
743
744
 
# File 'grafana/cfn_workspace.rb', line 741

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



751
752
753
754
755
 
# File 'grafana/cfn_workspace.rb', line 751

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#role_arn ⇒ String?

The IAM role that grants permissions to the AWS resources that the workspace will view data from.

Returns:

  • (String, nil) 


442
443
444
 
# File 'grafana/cfn_workspace.rb', line 442

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



446
447
448
449
 
# File 'grafana/cfn_workspace.rb', line 446

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless value.nil?
  jsii_set_property("roleArn", value)
end

#saml_configuration ⇒ AWSCDK::IResolvable, ...

If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.

Returns:



454
455
456
 
# File 'grafana/cfn_workspace.rb', line 454

def saml_configuration()
  jsii_get_property("samlConfiguration")
end

#saml_configuration=(value) ⇒ Object 



458
459
460
461
462
 
# File 'grafana/cfn_workspace.rb', line 458

def saml_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Grafana::CfnWorkspace::SamlConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ncmFmYW5hLkNmbldvcmtzcGFjZS5TYW1sQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "samlConfiguration") unless value.nil?
  jsii_set_property("samlConfiguration", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



760
761
762
 
# File 'grafana/cfn_workspace.rb', line 760

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



131
132
133
 
# File 'grafana/cfn_workspace.rb', line 131

def stack()
  jsii_get_property("stack")
end

#stack_set_name ⇒ String?

The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.

Returns:

  • (String, nil) 


467
468
469
 
# File 'grafana/cfn_workspace.rb', line 467

def stack_set_name()
  jsii_get_property("stackSetName")
end

#stack_set_name=(value) ⇒ Object 



471
472
473
474
 
# File 'grafana/cfn_workspace.rb', line 471

def stack_set_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stackSetName") unless value.nil?
  jsii_set_property("stackSetName", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



492
493
494
 
# File 'grafana/cfn_workspace.rb', line 492

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


178
179
180
 
# File 'grafana/cfn_workspace.rb', line 178

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


188
189
190
 
# File 'grafana/cfn_workspace.rb', line 188

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


766
767
768
769
 
# File 'grafana/cfn_workspace.rb', line 766

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpc_configuration ⇒ AWSCDK::IResolvable, ...

The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

Returns:



479
480
481
 
# File 'grafana/cfn_workspace.rb', line 479

def vpc_configuration()
  jsii_get_property("vpcConfiguration")
end

#vpc_configuration=(value) ⇒ Object 



483
484
485
486
487
 
# File 'grafana/cfn_workspace.rb', line 483

def vpc_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Grafana::CfnWorkspace::VPCConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ncmFmYW5hLkNmbldvcmtzcGFjZS5WcGNDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "vpcConfiguration") unless value.nil?
  jsii_set_property("vpcConfiguration", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


505
506
507
508
509
510
 
# File 'grafana/cfn_workspace.rb', line 505

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end

#workspace_ref ⇒ AWSCDK::Interfaces::AWSGrafana::WorkspaceReference

A reference to a Workspace resource.

Returns:



278
279
280
 
# File 'grafana/cfn_workspace.rb', line 278

def workspace_ref()
  jsii_get_property("workspaceRef")
end