Class CreatePresignedDomainUrlRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreatePresignedDomainUrlRequest.Builder,
CreatePresignedDomainUrlRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
domainId()
The domain ID.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
The number of seconds until the pre-signed URL expires.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
The landing page that the user is directed to when accessing the presigned URL.static Class
<? extends CreatePresignedDomainUrlRequest.Builder> final Integer
The session expiration duration in seconds.final String
The name of the space.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The name of the UserProfile to sign-in as.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
domainId
The domain ID.
- Returns:
- The domain ID.
-
userProfileName
The name of the UserProfile to sign-in as.
- Returns:
- The name of the UserProfile to sign-in as.
-
sessionExpirationDurationInSeconds
The session expiration duration in seconds. This value defaults to 43200.
- Returns:
- The session expiration duration in seconds. This value defaults to 43200.
-
expiresInSeconds
The number of seconds until the pre-signed URL expires. This value defaults to 300.
- Returns:
- The number of seconds until the pre-signed URL expires. This value defaults to 300.
-
spaceName
The name of the space.
- Returns:
- The name of the space.
-
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:
- 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.
-
-
-
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 interfaceToCopyableBuilder<CreatePresignedDomainUrlRequest.Builder,
CreatePresignedDomainUrlRequest> - Specified by:
toBuilder
in classSageMakerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-