Class: AWSCDK::IoTSiteWise::CfnPortal

Inherits:
CfnResource
  • Object
show all
Includes:
AWSCDK::IInspectable, AWSCDK::ITaggable, AWSCDK::Interfaces::AWSIotsitewise::IPortalRef
Defined in:
io_t_site_wise/cfn_portal.rb

Overview

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a portal, which can contain projects and dashboards. AWS IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.

Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the AWS IoT SiteWise User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnPortal

Create a new AWS::IoTSiteWise::Portal.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::IoTSiteWise::CfnPortalProps) —

    Resource properties.



24
25
26
27
28
29
30
 
# File 'io_t_site_wise/cfn_portal.rb', line 24

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::IoTSiteWise::CfnPortalProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90c2l0ZXdpc2UuQ2ZuUG9ydGFsUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_portal(resource) ⇒ String

Parameters:

Returns:

  • (String) 


90
91
92
93
 
# File 'io_t_site_wise/cfn_portal.rb', line 90

def self.arn_for_portal(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pb3RzaXRld2lzZS5JUG9ydGFsUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotsitewise.CfnPortal", "arnForPortal", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


223
224
225
 
# File 'io_t_site_wise/cfn_portal.rb', line 223

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

.from_portal_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSIotsitewise::IPortalRef

Creates a new IPortalRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



101
102
103
104
105
106
 
# File 'io_t_site_wise/cfn_portal.rb', line 101

def self.from_portal_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotsitewise.CfnPortal", "fromPortalArn", [scope, id, arn])
end

.from_portal_id(scope, id, portal_id) ⇒ AWSCDK::Interfaces::AWSIotsitewise::IPortalRef

Creates a new IPortalRef from a portalId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • portal_id (String)

Returns:



114
115
116
117
118
119
 
# File 'io_t_site_wise/cfn_portal.rb', line 114

def self.from_portal_id(scope, id, portal_id)
  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(portal_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "portalId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotsitewise.CfnPortal", "fromPortalId", [scope, id, portal_id])
end

.is_cfn_portal(x) ⇒ Boolean

Checks whether the given object is a CfnPortal.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


125
126
127
128
 
# File 'io_t_site_wise/cfn_portal.rb', line 125

def self.is_cfn_portal(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotsitewise.CfnPortal", "isCfnPortal", [x])
end

.jsii_overridable_methods ⇒ Object 



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
 
# File 'io_t_site_wise/cfn_portal.rb', line 32

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_portal_arn => { kind: :property, name: "attrPortalArn", is_optional: false },
    :attr_portal_client_id => { kind: :property, name: "attrPortalClientId", is_optional: false },
    :attr_portal_id => { kind: :property, name: "attrPortalId", is_optional: false },
    :attr_portal_start_url => { kind: :property, name: "attrPortalStartUrl", is_optional: false },
    :portal_ref => { kind: :property, name: "portalRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :alarms => { kind: :property, name: "alarms", is_optional: false },
    :portal_contact_email => { kind: :property, name: "portalContactEmail", is_optional: false },
    :portal_name => { kind: :property, name: "portalName", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :notification_sender_email => { kind: :property, name: "notificationSenderEmail", is_optional: true },
    :portal_auth_mode => { kind: :property, name: "portalAuthMode", is_optional: true },
    :portal_description => { kind: :property, name: "portalDescription", is_optional: true },
    :portal_type => { kind: :property, name: "portalType", is_optional: true },
    :portal_type_configuration => { kind: :property, name: "portalTypeConfiguration", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", 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

#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.



430
431
432
433
 
# File 'io_t_site_wise/cfn_portal.rb', line 430

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:



442
443
444
445
 
# File 'io_t_site_wise/cfn_portal.rb', line 442

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:



452
453
454
455
 
# File 'io_t_site_wise/cfn_portal.rb', line 452

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:



463
464
465
466
467
 
# File 'io_t_site_wise/cfn_portal.rb', line 463

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.


520
521
522
523
524
 
# File 'io_t_site_wise/cfn_portal.rb', line 520

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.



530
531
532
533
 
# File 'io_t_site_wise/cfn_portal.rb', line 530

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.



542
543
544
545
546
 
# File 'io_t_site_wise/cfn_portal.rb', line 542

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

#alarms ⇒ Object

Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.

Returns:

  • (Object) 


274
275
276
 
# File 'io_t_site_wise/cfn_portal.rb', line 274

def alarms()
  jsii_get_property("alarms")
end

#alarms=(value) ⇒ Object 



278
279
280
281
 
# File 'io_t_site_wise/cfn_portal.rb', line 278

def alarms=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "alarms")
  jsii_set_property("alarms", 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:



555
556
557
558
 
# File 'io_t_site_wise/cfn_portal.rb', line 555

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:



577
578
579
580
581
582
 
# File 'io_t_site_wise/cfn_portal.rb', line 577

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_portal_arn ⇒ String

The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

Returns:

  • (String) 


232
233
234
 
# File 'io_t_site_wise/cfn_portal.rb', line 232

def attr_portal_arn()
  jsii_get_property("attrPortalArn")
end

#attr_portal_client_id ⇒ String

The SSO application generated client ID (used with SSO APIs).

Returns:

  • (String) 


239
240
241
 
# File 'io_t_site_wise/cfn_portal.rb', line 239

def attr_portal_client_id()
  jsii_get_property("attrPortalClientId")
end

#attr_portal_id ⇒ String

The ID of the created portal.

Returns:

  • (String) 


246
247
248
 
# File 'io_t_site_wise/cfn_portal.rb', line 246

def attr_portal_id()
  jsii_get_property("attrPortalId")
end

#attr_portal_start_url ⇒ String

The public URL for the AWS IoT SiteWise Monitor portal.

Returns:

  • (String) 


253
254
255
 
# File 'io_t_site_wise/cfn_portal.rb', line 253

def attr_portal_start_url()
  jsii_get_property("attrPortalStartUrl")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



176
177
178
 
# File 'io_t_site_wise/cfn_portal.rb', line 176

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


181
182
183
 
# File 'io_t_site_wise/cfn_portal.rb', line 181

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


586
587
588
589
 
# File 'io_t_site_wise/cfn_portal.rb', line 586

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}) 


186
187
188
 
# File 'io_t_site_wise/cfn_portal.rb', line 186

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


193
194
195
 
# File 'io_t_site_wise/cfn_portal.rb', line 193

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


138
139
140
 
# File 'io_t_site_wise/cfn_portal.rb', line 138

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



198
199
200
 
# File 'io_t_site_wise/cfn_portal.rb', line 198

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:



599
600
601
602
603
 
# File 'io_t_site_wise/cfn_portal.rb', line 599

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:



610
611
612
613
 
# File 'io_t_site_wise/cfn_portal.rb', line 610

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



680
681
682
683
 
# File 'io_t_site_wise/cfn_portal.rb', line 680

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) 


150
151
152
 
# File 'io_t_site_wise/cfn_portal.rb', line 150

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


133
134
135
 
# File 'io_t_site_wise/cfn_portal.rb', line 133

def node()
  jsii_get_property("node")
end

#notification_sender_email ⇒ String?

The email address that sends alarm notifications.

Returns:

  • (String, nil) 


322
323
324
 
# File 'io_t_site_wise/cfn_portal.rb', line 322

def notification_sender_email()
  jsii_get_property("notificationSenderEmail")
end

#notification_sender_email=(value) ⇒ Object 



326
327
328
329
 
# File 'io_t_site_wise/cfn_portal.rb', line 326

def notification_sender_email=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "notificationSenderEmail") unless value.nil?
  jsii_set_property("notificationSenderEmail", 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:



621
622
623
 
# File 'io_t_site_wise/cfn_portal.rb', line 621

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:



628
629
630
 
# File 'io_t_site_wise/cfn_portal.rb', line 628

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
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.



421
422
423
424
 
# File 'io_t_site_wise/cfn_portal.rb', line 421

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

#portal_auth_mode ⇒ String?

The service to use to authenticate users to the portal.

Choose from the following options:.

Returns:

  • (String, nil) 


336
337
338
 
# File 'io_t_site_wise/cfn_portal.rb', line 336

def portal_auth_mode()
  jsii_get_property("portalAuthMode")
end

#portal_auth_mode=(value) ⇒ Object 



340
341
342
343
 
# File 'io_t_site_wise/cfn_portal.rb', line 340

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

#portal_contact_email ⇒ String

The AWS administrator's contact email address.

Returns:

  • (String) 


286
287
288
 
# File 'io_t_site_wise/cfn_portal.rb', line 286

def portal_contact_email()
  jsii_get_property("portalContactEmail")
end

#portal_contact_email=(value) ⇒ Object 



290
291
292
293
 
# File 'io_t_site_wise/cfn_portal.rb', line 290

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

#portal_description ⇒ String?

A description for the portal.

Returns:

  • (String, nil) 


348
349
350
 
# File 'io_t_site_wise/cfn_portal.rb', line 348

def portal_description()
  jsii_get_property("portalDescription")
end

#portal_description=(value) ⇒ Object 



352
353
354
355
 
# File 'io_t_site_wise/cfn_portal.rb', line 352

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

#portal_name ⇒ String

A friendly name for the portal.

Returns:

  • (String) 


298
299
300
 
# File 'io_t_site_wise/cfn_portal.rb', line 298

def portal_name()
  jsii_get_property("portalName")
end

#portal_name=(value) ⇒ Object 



302
303
304
305
 
# File 'io_t_site_wise/cfn_portal.rb', line 302

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

#portal_ref ⇒ AWSCDK::Interfaces::AWSIotsitewise::PortalReference

A reference to a Portal resource.

Returns:



260
261
262
 
# File 'io_t_site_wise/cfn_portal.rb', line 260

def portal_ref()
  jsii_get_property("portalRef")
end

#portal_type ⇒ String?

Define the type of portal.

Returns:

  • (String, nil) 


360
361
362
 
# File 'io_t_site_wise/cfn_portal.rb', line 360

def portal_type()
  jsii_get_property("portalType")
end

#portal_type=(value) ⇒ Object 



364
365
366
367
 
# File 'io_t_site_wise/cfn_portal.rb', line 364

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

#portal_type_configuration ⇒ AWSCDK::IResolvable, ...

Map to associate detail of configuration related with a PortalType.

Returns:



372
373
374
 
# File 'io_t_site_wise/cfn_portal.rb', line 372

def portal_type_configuration()
  jsii_get_property("portalTypeConfiguration")
end

#portal_type_configuration=(value) ⇒ Object 



376
377
378
379
 
# File 'io_t_site_wise/cfn_portal.rb', line 376

def portal_type_configuration=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90c2l0ZXdpc2UuQ2ZuUG9ydGFsLlBvcnRhbFR5cGVFbnRyeVByb3BlcnR5In1dfX0sImtpbmQiOiJtYXAifX1dfX0=")), "portalTypeConfiguration") unless value.nil?
  jsii_set_property("portalTypeConfiguration", 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) 


169
170
171
 
# File 'io_t_site_wise/cfn_portal.rb', line 169

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:



639
640
641
642
 
# File 'io_t_site_wise/cfn_portal.rb', line 639

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}) 


646
647
648
649
 
# File 'io_t_site_wise/cfn_portal.rb', line 646

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:



656
657
658
659
660
 
# File 'io_t_site_wise/cfn_portal.rb', line 656

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 ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide .

Returns:

  • (String) 


310
311
312
 
# File 'io_t_site_wise/cfn_portal.rb', line 310

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



314
315
316
317
 
# File 'io_t_site_wise/cfn_portal.rb', line 314

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  jsii_set_property("roleArn", 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.



665
666
667
 
# File 'io_t_site_wise/cfn_portal.rb', line 665

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:



159
160
161
 
# File 'io_t_site_wise/cfn_portal.rb', line 159

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



267
268
269
 
# File 'io_t_site_wise/cfn_portal.rb', line 267

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

A list of key-value pairs that contain metadata for the portal.

Returns:



384
385
386
 
# File 'io_t_site_wise/cfn_portal.rb', line 384

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



388
389
390
391
392
 
# File 'io_t_site_wise/cfn_portal.rb', line 388

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



397
398
399
 
# File 'io_t_site_wise/cfn_portal.rb', line 397

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}) 


206
207
208
 
# File 'io_t_site_wise/cfn_portal.rb', line 206

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}) 


216
217
218
 
# File 'io_t_site_wise/cfn_portal.rb', line 216

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


671
672
673
674
 
# File 'io_t_site_wise/cfn_portal.rb', line 671

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


410
411
412
413
414
415
 
# File 'io_t_site_wise/cfn_portal.rb', line 410

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