Interface CreatePresignedDomainUrlRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreatePresignedDomainUrlRequest.Builder,
,CreatePresignedDomainUrlRequest> SageMakerRequest.Builder
,SdkBuilder<CreatePresignedDomainUrlRequest.Builder,
,CreatePresignedDomainUrlRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreatePresignedDomainUrlRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe domain ID.expiresInSeconds
(Integer expiresInSeconds) The number of seconds until the pre-signed URL expires.landingUri
(String landingUri) The landing page that the user is directed to when accessing the presigned URL.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sessionExpirationDurationInSeconds
(Integer sessionExpirationDurationInSeconds) The session expiration duration in seconds.The name of the space.userProfileName
(String userProfileName) The name of the UserProfile to sign-in as.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.sagemaker.model.SageMakerRequest.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
-
domainId
The domain ID.
- Parameters:
domainId
- The domain ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userProfileName
The name of the UserProfile to sign-in as.
- Parameters:
userProfileName
- The name of the UserProfile to sign-in as.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sessionExpirationDurationInSeconds
CreatePresignedDomainUrlRequest.Builder sessionExpirationDurationInSeconds(Integer sessionExpirationDurationInSeconds) The session expiration duration in seconds. This value defaults to 43200.
- Parameters:
sessionExpirationDurationInSeconds
- The session expiration duration in seconds. This value defaults to 43200.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
expiresInSeconds
The number of seconds until the pre-signed URL expires. This value defaults to 300.
- Parameters:
expiresInSeconds
- The number of seconds until the pre-signed URL expires. This value defaults to 300.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
spaceName
The name of the space.
- Parameters:
spaceName
- The name of the space.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
landingUri
The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:
-
studio::relative/path
: Directs users to the relative path in Studio. -
app:JupyterServer:relative/path
: Directs users to the relative path in the Studio Classic application. -
app:JupyterLab:relative/path
: Directs users to the relative path in the JupyterLab application. -
app:RStudioServerPro:relative/path
: Directs users to the relative path in the RStudio application. -
app:CodeEditor:relative/path
: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application. -
app:Canvas:relative/path
: Directs users to the relative path in the Canvas application.
- Parameters:
landingUri
- The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:-
studio::relative/path
: Directs users to the relative path in Studio. -
app:JupyterServer:relative/path
: Directs users to the relative path in the Studio Classic application. -
app:JupyterLab:relative/path
: Directs users to the relative path in the JupyterLab application. -
app:RStudioServerPro:relative/path
: Directs users to the relative path in the RStudio application. -
app:CodeEditor:relative/path
: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application. -
app:Canvas:relative/path
: Directs users to the relative path in the Canvas application.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
CreatePresignedDomainUrlRequest.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
CreatePresignedDomainUrlRequest.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.
-