software.amazon.awssdk.services.appstream.model

Class CreateStackRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appstream.model.AppStreamRequest

software.amazon.awssdk.services.appstream.model.CreateStackRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateStackRequest.Builder,CreateStackRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateStackRequest
extends AppStreamRequest
implements ToCopyableBuilder<CreateStackRequest.Builder,CreateStackRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateStackRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<AccessEndpoint>	accessEndpoints() The list of interface VPC endpoint (interface endpoint) objects.
ApplicationSettings	applicationSettings() The persistent application settings for users of a stack.
static CreateStackRequest.Builder	builder()
String	description() The description to display.
String	displayName() The stack name to display.
List<String>	embedHostDomains() The domains where AppStream 2.0 streaming sessions can be embedded in an iframe.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	feedbackURL() The URL that users are redirected to after they click the Send Feedback link.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
boolean	hasAccessEndpoints() Returns true if the AccessEndpoints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasEmbedHostDomains() Returns true if the EmbedHostDomains property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasStorageConnectors() Returns true if the StorageConnectors property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasUserSettings() Returns true if the UserSettings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	name() The name of the stack.
String	redirectURL() The URL that users are redirected to after their streaming session ends.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateStackRequest.Builder>	serializableBuilderClass()
List<StorageConnector>	storageConnectors() The storage connectors to enable.
Map<String,String>	tags() The tags to associate with the stack.
CreateStackRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
List<UserSetting>	userSettings() The actions that are enabled or disabled for users during their streaming sessions.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public String name()

The name of the stack.

Returns:

The name of the stack.

description

public String description()

The description to display.

Returns:

The description to display.

displayName

public String displayName()

The stack name to display.

Returns:

The stack name to display.

hasStorageConnectors

public boolean hasStorageConnectors()

Returns true if the StorageConnectors property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

storageConnectors

public List<StorageConnector> storageConnectors()

The storage connectors to enable.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasStorageConnectors() to see if a value was sent in this field.

Returns:

The storage connectors to enable.

redirectURL

public String redirectURL()

The URL that users are redirected to after their streaming session ends.

Returns:

The URL that users are redirected to after their streaming session ends.

feedbackURL

public String feedbackURL()

The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

Returns:

The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

hasUserSettings

public boolean hasUserSettings()

Returns true if the UserSettings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

userSettings

public List<UserSetting> userSettings()

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasUserSettings() to see if a value was sent in this field.

Returns:

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

applicationSettings

public ApplicationSettings applicationSettings()

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

Returns:

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

hasTags

public boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public Map<String,String> tags()

The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

hasAccessEndpoints

public boolean hasAccessEndpoints()

Returns true if the AccessEndpoints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

accessEndpoints

public List<AccessEndpoint> accessEndpoints()

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAccessEndpoints() to see if a value was sent in this field.

Returns:

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

hasEmbedHostDomains

public boolean hasEmbedHostDomains()

Returns true if the EmbedHostDomains property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

embedHostDomains

public List<String> embedHostDomains()

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasEmbedHostDomains() to see if a value was sent in this field.

Returns:

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

toBuilder

public CreateStackRequest.Builder 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 interface ToCopyableBuilder<CreateStackRequest.Builder,CreateStackRequest>

Specified by:

toBuilder in class AppStreamRequest

Returns:

a builder for type T

builder

public static CreateStackRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateStackRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public String 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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.