Interface GenerateEmbedUrlForAnonymousUserRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GenerateEmbedUrlForAnonymousUserRequest.Builder,GenerateEmbedUrlForAnonymousUserRequest>, QuickSightRequest.Builder, SdkBuilder<GenerateEmbedUrlForAnonymousUserRequest.Builder,GenerateEmbedUrlForAnonymousUserRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GenerateEmbedUrlForAnonymousUserRequest
@Mutable @NotThreadSafe public static interface GenerateEmbedUrlForAnonymousUserRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<GenerateEmbedUrlForAnonymousUserRequest.Builder,GenerateEmbedUrlForAnonymousUserRequest>

  • Method Details

    • awsAccountId

      GenerateEmbedUrlForAnonymousUserRequest.Builder awsAccountId(String awsAccountId)

      The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

      Parameters:
      awsAccountId - The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionLifetimeInMinutes

      GenerateEmbedUrlForAnonymousUserRequest.Builder sessionLifetimeInMinutes(Long sessionLifetimeInMinutes)

      How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

      Parameters:
      sessionLifetimeInMinutes - How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • namespace

      GenerateEmbedUrlForAnonymousUserRequest.Builder namespace(String namespace)

      The Amazon Quick Sight namespace that the anonymous user virtually belongs to. If you are not using an Amazon Quick Suite custom namespace, set this to default.

      Parameters:
      namespace - The Amazon Quick Sight namespace that the anonymous user virtually belongs to. If you are not using an Amazon Quick Suite custom namespace, set this to default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionTags

      GenerateEmbedUrlForAnonymousUserRequest.Builder sessionTags(Collection<SessionTag> sessionTags)

      Session tags are user-specified strings that identify a session in your application. You can use these tags to implement row-level security (RLS) controls. Before you use the SessionTags parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

      When using session tags, you must call GenerateEmbedUrlForAnonymousUser from a secure, trusted environment. The API call passes session tags that enable server-side data redaction by using the row-level security (RLS) rules configured in your datasets. A secure, trusted environment has access controls that you implement. These controls ensure that only your server or authorized users can add or modify session tags.

      Besides, these are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags in the Amazon Quick Suite User Guide.

      Parameters:
      sessionTags - Session tags are user-specified strings that identify a session in your application. You can use these tags to implement row-level security (RLS) controls. Before you use the SessionTags parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

      When using session tags, you must call GenerateEmbedUrlForAnonymousUser from a secure, trusted environment. The API call passes session tags that enable server-side data redaction by using the row-level security (RLS) rules configured in your datasets. A secure, trusted environment has access controls that you implement. These controls ensure that only your server or authorized users can add or modify session tags.

      Besides, these are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags in the Amazon Quick Suite User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionTags

      GenerateEmbedUrlForAnonymousUserRequest.Builder sessionTags(SessionTag... sessionTags)

      Session tags are user-specified strings that identify a session in your application. You can use these tags to implement row-level security (RLS) controls. Before you use the SessionTags parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

      When using session tags, you must call GenerateEmbedUrlForAnonymousUser from a secure, trusted environment. The API call passes session tags that enable server-side data redaction by using the row-level security (RLS) rules configured in your datasets. A secure, trusted environment has access controls that you implement. These controls ensure that only your server or authorized users can add or modify session tags.

      Besides, these are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags in the Amazon Quick Suite User Guide.

      Parameters:
      sessionTags - Session tags are user-specified strings that identify a session in your application. You can use these tags to implement row-level security (RLS) controls. Before you use the SessionTags parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

      When using session tags, you must call GenerateEmbedUrlForAnonymousUser from a secure, trusted environment. The API call passes session tags that enable server-side data redaction by using the row-level security (RLS) rules configured in your datasets. A secure, trusted environment has access controls that you implement. These controls ensure that only your server or authorized users can add or modify session tags.

      Besides, these are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags in the Amazon Quick Suite User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionTags

      GenerateEmbedUrlForAnonymousUserRequest.Builder sessionTags(Consumer<SessionTag.Builder>... sessionTags)

      Session tags are user-specified strings that identify a session in your application. You can use these tags to implement row-level security (RLS) controls. Before you use the SessionTags parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

      When using session tags, you must call GenerateEmbedUrlForAnonymousUser from a secure, trusted environment. The API call passes session tags that enable server-side data redaction by using the row-level security (RLS) rules configured in your datasets. A secure, trusted environment has access controls that you implement. These controls ensure that only your server or authorized users can add or modify session tags.

      Besides, these are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags in the Amazon Quick Suite User Guide.

      This is a convenience method that creates an instance of the SessionTag.Builder avoiding the need to create one manually via SessionTag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sessionTags(List<SessionTag>).

      Parameters:
      sessionTags - a consumer that will call methods on SessionTag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authorizedResourceArns

      GenerateEmbedUrlForAnonymousUserRequest.Builder authorizedResourceArns(Collection<String> authorizedResourceArns)

      The Amazon Resource Names (ARNs) for the Quick Sight resources that the user is authorized to access during the lifetime of the session.

      If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.

      If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

      Currently, you can pass up to 25 theme ARNs in each API call.

      Parameters:
      authorizedResourceArns - The Amazon Resource Names (ARNs) for the Quick Sight resources that the user is authorized to access during the lifetime of the session.

      If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.

      If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

      Currently, you can pass up to 25 theme ARNs in each API call.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authorizedResourceArns

      GenerateEmbedUrlForAnonymousUserRequest.Builder authorizedResourceArns(String... authorizedResourceArns)

      The Amazon Resource Names (ARNs) for the Quick Sight resources that the user is authorized to access during the lifetime of the session.

      If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.

      If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

      Currently, you can pass up to 25 theme ARNs in each API call.

      Parameters:
      authorizedResourceArns - The Amazon Resource Names (ARNs) for the Quick Sight resources that the user is authorized to access during the lifetime of the session.

      If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.

      If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

      Currently, you can pass up to 25 theme ARNs in each API call.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • experienceConfiguration

      GenerateEmbedUrlForAnonymousUserRequest.Builder experienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration)

      The configuration of the experience that you are embedding.

      Parameters:
      experienceConfiguration - The configuration of the experience that you are embedding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • experienceConfiguration

      default GenerateEmbedUrlForAnonymousUserRequest.Builder experienceConfiguration(Consumer<AnonymousUserEmbeddingExperienceConfiguration.Builder> experienceConfiguration)

      The configuration of the experience that you are embedding.

      This is a convenience method that creates an instance of the AnonymousUserEmbeddingExperienceConfiguration.Builder avoiding the need to create one manually via AnonymousUserEmbeddingExperienceConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to experienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration).

      Parameters:
      experienceConfiguration - a consumer that will call methods on AnonymousUserEmbeddingExperienceConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • allowedDomains

      GenerateEmbedUrlForAnonymousUserRequest.Builder allowedDomains(Collection<String> allowedDomains)

      The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage Quick Sight menu in the Amazon Quick Sight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

      To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

      Parameters:
      allowedDomains - The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage Quick Sight menu in the Amazon Quick Sight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

      To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowedDomains

      GenerateEmbedUrlForAnonymousUserRequest.Builder allowedDomains(String... allowedDomains)

      The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage Quick Sight menu in the Amazon Quick Sight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

      To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

      Parameters:
      allowedDomains - The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage Quick Sight menu in the Amazon Quick Sight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

      To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GenerateEmbedUrlForAnonymousUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GenerateEmbedUrlForAnonymousUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.