Class: Aws::QuickSight::Types::AccessControlApplication

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

An access control application. It defines how an external client signs in to Quick Sight with OAuth 2.0. Client secret values are never included.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The ID of the access control application.

Returns:

  • (String)


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 105

class AccessControlApplication < Struct.new(
  :application_id,
  :arn,
  :name,
  :namespace,
  :authentication_type,
  :status,
  :created_time,
  :last_updated_time,
  :tenant_url,
  :description,
  :idc_application_arn,
  :idp_authorizing_configuration,
  :quick_authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The ARN of the access control application.

Returns:

  • (String)


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 105

class AccessControlApplication < Struct.new(
  :application_id,
  :arn,
  :name,
  :namespace,
  :authentication_type,
  :status,
  :created_time,
  :last_updated_time,
  :tenant_url,
  :description,
  :idc_application_arn,
  :idp_authorizing_configuration,
  :quick_authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#authentication_type ⇒ String

The authentication protocol that the access control application uses.

Returns:

  • (String)


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 105

class AccessControlApplication < Struct.new(
  :application_id,
  :arn,
  :name,
  :namespace,
  :authentication_type,
  :status,
  :created_time,
  :last_updated_time,
  :tenant_url,
  :description,
  :idc_application_arn,
  :idp_authorizing_configuration,
  :quick_authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#created_time ⇒ Time

The time when the access control application was created.

Returns:

  • (Time)


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 105

class AccessControlApplication < Struct.new(
  :application_id,
  :arn,
  :name,
  :namespace,
  :authentication_type,
  :status,
  :created_time,
  :last_updated_time,
  :tenant_url,
  :description,
  :idc_application_arn,
  :idp_authorizing_configuration,
  :quick_authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the access control application.

Returns:

  • (String)


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 105

class AccessControlApplication < Struct.new(
  :application_id,
  :arn,
  :name,
  :namespace,
  :authentication_type,
  :status,
  :created_time,
  :last_updated_time,
  :tenant_url,
  :description,
  :idc_application_arn,
  :idp_authorizing_configuration,
  :quick_authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#idc_application_arn ⇒ String

The ARN of the Amazon Web Services IAM Identity Center application that Quick Sight manages for this access control application. This value is present when the IdpAuthorizingType is IDC_AUTH_CODE, or when a trusted token issuer is configured.

Returns:

  • (String)


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 105

class AccessControlApplication < Struct.new(
  :application_id,
  :arn,
  :name,
  :namespace,
  :authentication_type,
  :status,
  :created_time,
  :last_updated_time,
  :tenant_url,
  :description,
  :idc_application_arn,
  :idp_authorizing_configuration,
  :quick_authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#idp_authorizing_configuration ⇒ Types::IdpAuthorizingConfig

The identity provider configuration of the access control application. Client secret values are never included.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 105

class AccessControlApplication < Struct.new(
  :application_id,
  :arn,
  :name,
  :namespace,
  :authentication_type,
  :status,
  :created_time,
  :last_updated_time,
  :tenant_url,
  :description,
  :idc_application_arn,
  :idp_authorizing_configuration,
  :quick_authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time ⇒ Time

The time when the access control application was last updated.

Returns:

  • (Time)


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 105

class AccessControlApplication < Struct.new(
  :application_id,
  :arn,
  :name,
  :namespace,
  :authentication_type,
  :status,
  :created_time,
  :last_updated_time,
  :tenant_url,
  :description,
  :idc_application_arn,
  :idp_authorizing_configuration,
  :quick_authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the access control application.

Returns:

  • (String)


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 105

class AccessControlApplication < Struct.new(
  :application_id,
  :arn,
  :name,
  :namespace,
  :authentication_type,
  :status,
  :created_time,
  :last_updated_time,
  :tenant_url,
  :description,
  :idc_application_arn,
  :idp_authorizing_configuration,
  :quick_authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The Quick Sight namespace that the access control application belongs to.

Returns:

  • (String)


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 105

class AccessControlApplication < Struct.new(
  :application_id,
  :arn,
  :name,
  :namespace,
  :authentication_type,
  :status,
  :created_time,
  :last_updated_time,
  :tenant_url,
  :description,
  :idc_application_arn,
  :idp_authorizing_configuration,
  :quick_authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#quick_authentication_configuration ⇒ Types::QuickAuthenticationConfig

The Quick Sight authentication configuration of the access control application. Client secret values are never included.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 105

class AccessControlApplication < Struct.new(
  :application_id,
  :arn,
  :name,
  :namespace,
  :authentication_type,
  :status,
  :created_time,
  :last_updated_time,
  :tenant_url,
  :description,
  :idc_application_arn,
  :idp_authorizing_configuration,
  :quick_authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the access control application.

Returns:

  • (String)


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 105

class AccessControlApplication < Struct.new(
  :application_id,
  :arn,
  :name,
  :namespace,
  :authentication_type,
  :status,
  :created_time,
  :last_updated_time,
  :tenant_url,
  :description,
  :idc_application_arn,
  :idp_authorizing_configuration,
  :quick_authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tenant_url ⇒ String

The tenant URL of the access control application. This URL hosts the OAuth 2.0 and OpenID Connect endpoints for the application, such as /authorize, /token, /.well-known/openid-configuration, and /jwks.

Returns:

  • (String)


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 105

class AccessControlApplication < Struct.new(
  :application_id,
  :arn,
  :name,
  :namespace,
  :authentication_type,
  :status,
  :created_time,
  :last_updated_time,
  :tenant_url,
  :description,
  :idc_application_arn,
  :idp_authorizing_configuration,
  :quick_authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end