Class: AWSCDK::SSO::CfnApplicationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sso/cfn_application_props.rb

Overview

Properties for defining a CfnApplication.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_provider_arn:, instance_arn:, name:, description: nil, portal_options: nil, status: nil, tags: nil) ⇒ CfnApplicationProps

Returns a new instance of CfnApplicationProps.

Parameters:

  • application_provider_arn (String) —

    The ARN of the application provider for this application.

  • instance_arn (String) —

    The ARN of the instance of IAM Identity Center that is configured with this application.

  • name (String) —

    The name of the application.

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

    The description of the application.

  • portal_options (AWSCDK::IResolvable, AWSCDK::SSO::CfnApplication::PortalOptionsConfigurationProperty, nil) (defaults to: nil) —

    A structure that describes the options for the access portal associated with this application.

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

    The current status of the application in this instance of IAM Identity Center.

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

    Specifies tags to be attached to the application.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'sso/cfn_application_props.rb', line 16

def initialize(application_provider_arn:, instance_arn:, name:, description: nil, portal_options: nil, status: nil, tags: nil)
  @application_provider_arn = application_provider_arn
  Jsii::Type.check_type(@application_provider_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationProviderArn")
  @instance_arn = instance_arn
  Jsii::Type.check_type(@instance_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceArn")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @portal_options = portal_options.is_a?(Hash) ? ::AWSCDK::SSO::CfnApplication::PortalOptionsConfigurationProperty.new(**portal_options.transform_keys(&:to_sym)) : portal_options
  Jsii::Type.check_type(@portal_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zc28uQ2ZuQXBwbGljYXRpb24uUG9ydGFsT3B0aW9uc0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "portalOptions") unless @portal_options.nil?
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.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

#application_provider_arn ⇒ String (readonly)

The ARN of the application provider for this application.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'sso/cfn_application_props.rb', line 37

def application_provider_arn
  @application_provider_arn
end

#description ⇒ String? (readonly)

The description of the application.

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'sso/cfn_application_props.rb', line 52

def description
  @description
end

#instance_arn ⇒ String (readonly)

The ARN of the instance of IAM Identity Center that is configured with this application.

Returns:

  • (String)

See Also:



42
43
44
 
# File 'sso/cfn_application_props.rb', line 42

def instance_arn
  @instance_arn
end

#name ⇒ String (readonly)

The name of the application.

Returns:

  • (String)

See Also:



47
48
49
 
# File 'sso/cfn_application_props.rb', line 47

def name
  @name
end

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

A structure that describes the options for the access portal associated with this application.

Returns:

See Also:



57
58
59
 
# File 'sso/cfn_application_props.rb', line 57

def portal_options
  @portal_options
end

#status ⇒ String? (readonly)

The current status of the application in this instance of IAM Identity Center.

Returns:

  • (String, nil)

See Also:



62
63
64
 
# File 'sso/cfn_application_props.rb', line 62

def status
  @status
end

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

Specifies tags to be attached to the application.

Returns:

See Also:



67
68
69
 
# File 'sso/cfn_application_props.rb', line 67

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'sso/cfn_application_props.rb', line 69

def self.jsii_properties
  {
    :application_provider_arn => "applicationProviderArn",
    :instance_arn => "instanceArn",
    :name => "name",
    :description => "description",
    :portal_options => "portalOptions",
    :status => "status",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'sso/cfn_application_props.rb', line 81

def to_jsii
  result = {}
  result.merge!({
    "applicationProviderArn" => @application_provider_arn,
    "instanceArn" => @instance_arn,
    "name" => @name,
    "description" => @description,
    "portalOptions" => @portal_options,
    "status" => @status,
    "tags" => @tags,
  })
  result.compact
end