Class: AWSCDK::QBusiness::CfnApplication::AutoSubscriptionConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QBusiness::CfnApplication::AutoSubscriptionConfigurationProperty

Defined in:

q_business/cfn_application.rb

Overview

Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-autosubscriptionconfiguration.html

Instance Attribute Summary

• #auto_subscribe ⇒ String readonly

  Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.

• #default_subscription_type ⇒ String^? readonly

  Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(auto_subscribe:, default_subscription_type: nil) ⇒ AutoSubscriptionConfigurationProperty constructor

  A new instance of AutoSubscriptionConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(auto_subscribe:, default_subscription_type: nil) ⇒ AutoSubscriptionConfigurationProperty

Returns a new instance of AutoSubscriptionConfigurationProperty.

Parameters:

• auto_subscribe (String) —

  Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.

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

  Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.

# File 'q_business/cfn_application.rb', line 800

def initialize(auto_subscribe:, default_subscription_type: nil)
  @auto_subscribe = auto_subscribe
  Jsii::Type.check_type(@auto_subscribe, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "autoSubscribe")
  @default_subscription_type = default_subscription_type
  Jsii::Type.check_type(@default_subscription_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultSubscriptionType") unless @default_subscription_type.nil?
end

Instance Attribute Details

#auto_subscribe ⇒ String (readonly)

Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-autosubscriptionconfiguration.html#cfn-qbusiness-application-autosubscriptionconfiguration-autosubscribe

# File 'q_business/cfn_application.rb', line 811

def auto_subscribe
  @auto_subscribe
end

#default_subscription_type ⇒ String^? (readonly)

Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.

If the value for auto_subscribe is set to ENABLED you must select a value for this field.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-autosubscriptionconfiguration.html#cfn-qbusiness-application-autosubscriptionconfiguration-defaultsubscriptiontype

# File 'q_business/cfn_application.rb', line 818

def default_subscription_type
  @default_subscription_type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'q_business/cfn_application.rb', line 820

def self.jsii_properties
  {
    :auto_subscribe => "autoSubscribe",
    :default_subscription_type => "defaultSubscriptionType",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'q_business/cfn_application.rb', line 827

def to_jsii
  result = {}
  result.merge!({
    "autoSubscribe" => @auto_subscribe,
    "defaultSubscriptionType" => @default_subscription_type,
  })
  result.compact
end