Interface CreateWorkspaceApiKeyRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateWorkspaceApiKeyRequest.Builder,CreateWorkspaceApiKeyRequest>, GrafanaRequest.Builder, SdkBuilder<CreateWorkspaceApiKeyRequest.Builder,CreateWorkspaceApiKeyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateWorkspaceApiKeyRequest

@Mutable
@NotThreadSafe
public static interface CreateWorkspaceApiKeyRequest.Builder
extends GrafanaRequest.Builder, SdkPojo, CopyableBuilder<CreateWorkspaceApiKeyRequest.Builder,CreateWorkspaceApiKeyRequest>

Method Summary

Modifier and Type	Method	Description
CreateWorkspaceApiKeyRequest.Builder	keyName(String keyName)	Specifies the name of the key.
CreateWorkspaceApiKeyRequest.Builder	keyRole(String keyRole)	Specifies the permission level of the key.
CreateWorkspaceApiKeyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateWorkspaceApiKeyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateWorkspaceApiKeyRequest.Builder	secondsToLive(Integer secondsToLive)	Specifies the time in seconds until the key expires.
CreateWorkspaceApiKeyRequest.Builder	workspaceId(String workspaceId)	The ID of the workspace to create an API key.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.grafana.model.GrafanaRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

keyName

CreateWorkspaceApiKeyRequest.Builder keyName(String keyName)

Specifies the name of the key. Keynames must be unique to the workspace.

Parameters:

keyName - Specifies the name of the key. Keynames must be unique to the workspace.

Returns:

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

keyRole

CreateWorkspaceApiKeyRequest.Builder keyRole(String keyRole)

Specifies the permission level of the key.

Valid values: ADMIN|EDITOR|VIEWER

Parameters:

keyRole - Specifies the permission level of the key.

Valid values: ADMIN|EDITOR|VIEWER

Returns:

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

secondsToLive

CreateWorkspaceApiKeyRequest.Builder secondsToLive(Integer secondsToLive)

Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

Parameters:

secondsToLive - Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

Returns:

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

workspaceId

CreateWorkspaceApiKeyRequest.Builder workspaceId(String workspaceId)

The ID of the workspace to create an API key.

Parameters:

workspaceId - The ID of the workspace to create an API key.

Returns:

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

overrideConfiguration

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

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