Class: AWSCDK::Cognito::CfnUserPoolResourceServer::ResourceServerScopeTypeProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Cognito::CfnUserPoolResourceServer::ResourceServerScopeTypeProperty

Defined in:

cognito/cfn_user_pool_resource_server.rb

Overview

One custom scope associated with a user pool resource server.

This data type is a member of ResourceServerScopeType . For more information, see Scopes, M2M, and API authorization with resource servers .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html

Instance Attribute Summary

• #scope_description ⇒ String readonly

  A friendly description of a custom scope.

• #scope_name ⇒ String readonly

  The name of the scope.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(scope_description:, scope_name:) ⇒ ResourceServerScopeTypeProperty constructor

  A new instance of ResourceServerScopeTypeProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(scope_description:, scope_name:) ⇒ ResourceServerScopeTypeProperty

Returns a new instance of ResourceServerScopeTypeProperty.

Parameters:

• scope_description (String) —

  A friendly description of a custom scope.

• scope_name (String) —

  The name of the scope.

# File 'cognito/cfn_user_pool_resource_server.rb', line 536

def initialize(scope_description:, scope_name:)
  @scope_description = scope_description
  Jsii::Type.check_type(@scope_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scopeDescription")
  @scope_name = scope_name
  Jsii::Type.check_type(@scope_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scopeName")
end

Instance Attribute Details

#scope_description ⇒ String (readonly)

A friendly description of a custom scope.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html#cfn-cognito-userpoolresourceserver-resourceserverscopetype-scopedescription

# File 'cognito/cfn_user_pool_resource_server.rb', line 547

def scope_description
  @scope_description
end

#scope_name ⇒ String (readonly)

The name of the scope.

Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName . For example, if this parameter is example_scope in the resource server with the identifier example_resource_server , you request and receive the scope exampleResourceServer/exampleScope .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html#cfn-cognito-userpoolresourceserver-resourceserverscopetype-scopename

# File 'cognito/cfn_user_pool_resource_server.rb', line 554

def scope_name
  @scope_name
end

Class Method Details

.jsii_properties ⇒ Object

# File 'cognito/cfn_user_pool_resource_server.rb', line 556

def self.jsii_properties
  {
    :scope_description => "scopeDescription",
    :scope_name => "scopeName",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'cognito/cfn_user_pool_resource_server.rb', line 563

def to_jsii
  result = {}
  result.merge!({
    "scopeDescription" => @scope_description,
    "scopeName" => @scope_name,
  })
  result.compact
end