Class: Aws::ManagedGrafana::Types::CreateWorkspaceRequest

Inherits:

Struct

Object
Struct
Aws::ManagedGrafana::Types::CreateWorkspaceRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-managedgrafana/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]

Instance Attribute Summary collapse

#account_access_type ⇒ String

Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization.
#authentication_providers ⇒ Array<String>

Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace.
#client_token ⇒ String

A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
#configuration ⇒ String

The configuration string for the workspace that you create.
#grafana_version ⇒ String

Specifies the version of Grafana to support in the new workspace.
#network_access_control ⇒ Types::NetworkAccessConfiguration

Configuration for network access to your workspace.
#organization_role_name ⇒ String

The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.
#permission_type ⇒ String

When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
#stack_set_name ⇒ String

The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
#tags ⇒ Hash<String,String>

The list of tags associated with the workspace.
#vpc_configuration ⇒ Types::VpcConfiguration

The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
#workspace_data_sources ⇒ Array<String>

This parameter is for internal use only, and should not be used.
#workspace_description ⇒ String

A description for the workspace.
#workspace_name ⇒ String

The name for the workspace.
#workspace_notification_destinations ⇒ Array<String>

Specify the Amazon Web Services notification channels that you plan to use in this workspace.
#workspace_organizational_units ⇒ Array<String>

Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.
#workspace_role_arn ⇒ String

Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels.

Instance Attribute Details

#account_access_type ⇒ `String`

Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If you specify ‘ORGANIZATION`, you must specify which organizational units the workspace can access in the `workspaceOrganizationalUnits` parameter.

Returns:

(String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#authentication_providers ⇒ `Array<String>`

Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see [User authentication in Amazon Managed Grafana].

[1]: docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html

Returns:

(Array<String>)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#client_token ⇒ `String`

A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

(String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#configuration ⇒ `String`

The configuration string for the workspace that you create. For more information about the format and configuration options available, see [Working in your Grafana workspace].

[1]: docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html

Returns:

(String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#grafana_version ⇒ `String`

Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 10.4).

To get a list of supported versions, use the ‘ListVersions` operation.

Returns:

(String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#network_access_control ⇒ `Types::NetworkAccessConfiguration`

Configuration for network access to your workspace.

When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.

If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

Returns:

(Types::NetworkAccessConfiguration)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#organization_role_name ⇒ `String`

The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.

Returns:

(String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#permission_type ⇒ `String`

When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

You must also specify a ‘workspaceRoleArn` for a role that you will manage for the workspace to use when accessing those datasources and notification channels.

The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to ‘SERVICE_MANAGED`.

<note markdown=“1”> Use only the ‘CUSTOMER_MANAGED` permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.

</note>

For more information, see [Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels].

[1]: docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html

Returns:

(String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#stack_set_name ⇒ `String`

The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.

Returns:

(String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

The list of tags associated with the workspace.

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#vpc_configuration ⇒ `Types::VpcConfiguration`

The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

<note markdown=“1”> Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).

</note>

Returns:

(Types::VpcConfiguration)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#workspace_data_sources ⇒ `Array<String>`

This parameter is for internal use only, and should not be used.

Returns:

(Array<String>)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#workspace_description ⇒ `String`

A description for the workspace. This is used only to help you identify this workspace.

Pattern: ‘^[\pL\pZ\pN\pP]0,2048$`

Returns:

(String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#workspace_name ⇒ `String`

The name for the workspace. It does not have to be unique.

Returns:

(String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#workspace_notification_destinations ⇒ `Array<String>`

Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.

Returns:

(Array<String>)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#workspace_organizational_units ⇒ `Array<String>`

Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.

Returns:

(Array<String>)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#workspace_role_arn ⇒ `String`

Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.

Returns:

(String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 415

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :configuration,
  :grafana_version,
  :network_access_control,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :tags,
  :vpc_configuration,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

Class: Aws::ManagedGrafana::Types::CreateWorkspaceRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#account_access_type ⇒ String

#authentication_providers ⇒ Array<String>

#client_token ⇒ String

#configuration ⇒ String

#grafana_version ⇒ String

#network_access_control ⇒ Types::NetworkAccessConfiguration

#organization_role_name ⇒ String

#permission_type ⇒ String

#stack_set_name ⇒ String

#tags ⇒ Hash<String,String>

#vpc_configuration ⇒ Types::VpcConfiguration

#workspace_data_sources ⇒ Array<String>

#workspace_description ⇒ String

#workspace_name ⇒ String

#workspace_notification_destinations ⇒ Array<String>

#workspace_organizational_units ⇒ Array<String>

#workspace_role_arn ⇒ String

#account_access_type ⇒ `String`

#authentication_providers ⇒ `Array<String>`

#client_token ⇒ `String`

#configuration ⇒ `String`

#grafana_version ⇒ `String`

#network_access_control ⇒ `Types::NetworkAccessConfiguration`

#organization_role_name ⇒ `String`

#permission_type ⇒ `String`

#stack_set_name ⇒ `String`

#tags ⇒ `Hash<String,String>`

#vpc_configuration ⇒ `Types::VpcConfiguration`

#workspace_data_sources ⇒ `Array<String>`

#workspace_description ⇒ `String`

#workspace_name ⇒ `String`

#workspace_notification_destinations ⇒ `Array<String>`

#workspace_organizational_units ⇒ `Array<String>`

#workspace_role_arn ⇒ `String`