Package software.amazon.awssdk.services.appstream.model

Class CreateStackRequest

    • Method Detail

      • name

        public final String name()

        The name of the stack.

        Returns:
        The name of the stack.

      • description

        public final String description()

        The description to display.

        Returns:
        The description to display.

      • displayName

        public final String displayName()

        The stack name to display.

        Returns:
        The stack name to display.

      • hasStorageConnectors

        public final boolean hasStorageConnectors()
        For responses, this returns true if the service returned a value for the StorageConnectors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • storageConnectors

        public final List<StorageConnector> storageConnectors()

        The storage connectors to enable.

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

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStorageConnectors() method.

        Returns:
        The storage connectors to enable.

      • redirectURL

        public final 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 final 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 final boolean hasUserSettings()
        For responses, this returns true if the service returned a value for the UserSettings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • userSettings

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

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserSettings() method.

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

      • applicationSettings

        public final 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 final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

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

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        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 final boolean hasAccessEndpoints()
        For responses, this returns true if the service returned a value for the AccessEndpoints property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • accessEndpoints

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

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAccessEndpoints() method.

        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 final boolean hasEmbedHostDomains()
        For responses, this returns true if the service returned a value for the EmbedHostDomains property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • embedHostDomains

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

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEmbedHostDomains() method.

        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.

      • streamingExperienceSettings

        public final StreamingExperienceSettings streamingExperienceSettings()

        The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

        Returns:
        The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

      • toString

        public final 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