Class: AWSCDK::Connect::CfnWorkspace::WorkspacePageProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
connect/cfn_workspace.rb

Overview

Contains information about a page configuration in a workspace, including the view assigned to the page.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(page:, resource_arn:, input_data: nil, slug: nil) ⇒ WorkspacePageProperty

Returns a new instance of WorkspacePageProperty.

Parameters:

  • page (String) —

    The page identifier.

  • resource_arn (String) —

    The Amazon Resource Name (ARN) of the view associated with this page.

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

    A JSON string containing input parameters passed to the view when the page is rendered.

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

    The URL-friendly identifier for the page.



986
987
988
989
990
991
992
993
994
995
 
# File 'connect/cfn_workspace.rb', line 986

def initialize(page:, resource_arn:, input_data: nil, slug: nil)
  @page = page
  Jsii::Type.check_type(@page, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "page")
  @resource_arn = resource_arn
  Jsii::Type.check_type(@resource_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceArn")
  @input_data = input_data
  Jsii::Type.check_type(@input_data, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputData") unless @input_data.nil?
  @slug = slug
  Jsii::Type.check_type(@slug, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "slug") unless @slug.nil?
end

Instance Attribute Details

#input_data ⇒ String? (readonly)

A JSON string containing input parameters passed to the view when the page is rendered.

Returns:

  • (String, nil)

See Also:



1013
1014
1015
 
# File 'connect/cfn_workspace.rb', line 1013

def input_data
  @input_data
end

#page ⇒ String (readonly)

The page identifier.

System pages include HOME and AGENT_EXPERIENCE .

Returns:

  • (String)

See Also:



1003
1004
1005
 
# File 'connect/cfn_workspace.rb', line 1003

def page
  @page
end

#resource_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the view associated with this page.

Returns:

  • (String)

See Also:



1008
1009
1010
 
# File 'connect/cfn_workspace.rb', line 1008

def resource_arn
  @resource_arn
end

#slug ⇒ String? (readonly)

The URL-friendly identifier for the page.

Returns:

  • (String, nil)

See Also:



1018
1019
1020
 
# File 'connect/cfn_workspace.rb', line 1018

def slug
  @slug
end

Class Method Details

.jsii_properties ⇒ Object 



1020
1021
1022
1023
1024
1025
1026
1027
 
# File 'connect/cfn_workspace.rb', line 1020

def self.jsii_properties
  {
    :page => "page",
    :resource_arn => "resourceArn",
    :input_data => "inputData",
    :slug => "slug",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'connect/cfn_workspace.rb', line 1029

def to_jsii
  result = {}
  result.merge!({
    "page" => @page,
    "resourceArn" => @resource_arn,
    "inputData" => @input_data,
    "slug" => @slug,
  })
  result.compact
end