Interface CreateWorkspaceApiKeyRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateWorkspaceApiKeyRequest.Builder,
,CreateWorkspaceApiKeyRequest> GrafanaRequest.Builder
,SdkBuilder<CreateWorkspaceApiKeyRequest.Builder,
,CreateWorkspaceApiKeyRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateWorkspaceApiKeyRequest
public static interface CreateWorkspaceApiKeyRequest.Builder
extends GrafanaRequest.Builder, SdkPojo, CopyableBuilder<CreateWorkspaceApiKeyRequest.Builder,CreateWorkspaceApiKeyRequest>
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies the name of the key.Specifies the permission level of the key.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.secondsToLive
(Integer secondsToLive) Specifies the time in seconds until the key expires.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, sdkFields
-
Method Details
-
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
Specifies the permission level of the key.
Valid values:
VIEWER
|EDITOR
|ADMIN
- Parameters:
keyRole
- Specifies the permission level of the key.Valid values:
VIEWER
|EDITOR
|ADMIN
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-