Package software.amazon.awssdk.services.grafana.model

Class CreateWorkspaceRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.grafana.model.GrafanaRequest
software.amazon.awssdk.services.grafana.model.CreateWorkspaceRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateWorkspaceRequest.Builder,CreateWorkspaceRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateWorkspaceRequest extends GrafanaRequest implements ToCopyableBuilder<CreateWorkspaceRequest.Builder,CreateWorkspaceRequest>

  • Method Details

    • accountAccessType

      public final AccountAccessType accountAccessType()

      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.

      If the service returns an enum value that is not available in the current SDK version, accountAccessType will return AccountAccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accountAccessTypeAsString().

      Returns:
      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.
      See Also:

    • accountAccessTypeAsString

      public final String accountAccessTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, accountAccessType will return AccountAccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accountAccessTypeAsString().

      Returns:
      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.
      See Also:

    • authenticationProviders

      public final List<AuthenticationProviderTypes> authenticationProviders()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAuthenticationProviders() method.

      Returns:
      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.

    • hasAuthenticationProviders

      public final boolean hasAuthenticationProviders()
      For responses, this returns true if the service returned a value for the AuthenticationProviders property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • authenticationProvidersAsStrings

      public final List<String> authenticationProvidersAsStrings()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAuthenticationProviders() method.

      Returns:
      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.

    • clientToken

      public final String clientToken()

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

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

    • configuration

      public final String configuration()

      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.

      Returns:
      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.

    • grafanaVersion

      public final String grafanaVersion()

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

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

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

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

    • networkAccessControl

      public final NetworkAccessConfiguration networkAccessControl()

      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:
      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.

    • organizationRoleName

      public final String organizationRoleName()

      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:
      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.

    • permissionType

      public final PermissionType permissionType()

      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.

      Use only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.

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

      If the service returns an enum value that is not available in the current SDK version, permissionType will return PermissionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionTypeAsString().

      Returns:
      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.

      Use only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.

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

      See Also:

    • permissionTypeAsString

      public final String permissionTypeAsString()

      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.

      Use only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.

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

      If the service returns an enum value that is not available in the current SDK version, permissionType will return PermissionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionTypeAsString().

      Returns:
      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.

      Use only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.

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

      See Also:

    • stackSetName

      public final String stackSetName()

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

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

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      The list of tags associated with the workspace.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The list of tags associated with the workspace.

    • vpcConfiguration

      public final VpcConfiguration vpcConfiguration()

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

      Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).

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

      Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).

    • workspaceDataSources

      public final List<DataSourceType> workspaceDataSources()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWorkspaceDataSources() method.

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

    • hasWorkspaceDataSources

      public final boolean hasWorkspaceDataSources()
      For responses, this returns true if the service returned a value for the WorkspaceDataSources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • workspaceDataSourcesAsStrings

      public final List<String> workspaceDataSourcesAsStrings()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWorkspaceDataSources() method.

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

    • workspaceDescription

      public final String workspaceDescription()

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

      Pattern: ^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$

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

      Pattern: ^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$

    • workspaceName

      public final String workspaceName()

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

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

    • workspaceNotificationDestinations

      public final List<NotificationDestinationType> workspaceNotificationDestinations()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWorkspaceNotificationDestinations() method.

      Returns:
      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.

    • hasWorkspaceNotificationDestinations

      public final boolean hasWorkspaceNotificationDestinations()
      For responses, this returns true if the service returned a value for the WorkspaceNotificationDestinations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • workspaceNotificationDestinationsAsStrings

      public final List<String> workspaceNotificationDestinationsAsStrings()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWorkspaceNotificationDestinations() method.

      Returns:
      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.

    • hasWorkspaceOrganizationalUnits

      public final boolean hasWorkspaceOrganizationalUnits()
      For responses, this returns true if the service returned a value for the WorkspaceOrganizationalUnits property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • workspaceOrganizationalUnits

      public final List<String> workspaceOrganizationalUnits()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWorkspaceOrganizationalUnits() method.

      Returns:
      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.

    • workspaceRoleArn

      public final String workspaceRoleArn()

      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:
      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.

    • toBuilder

      public CreateWorkspaceRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateWorkspaceRequest.Builder,CreateWorkspaceRequest>
      Specified by:
      toBuilder in class GrafanaRequest
      Returns:
      a builder for type T

    • builder

      public static CreateWorkspaceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateWorkspaceRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.