software.amazon.awssdk.services.appstream.model

Class CreateAppBlockBuilderRequest

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.CreateAppBlockBuilderRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAppBlockBuilderRequest.Builder,CreateAppBlockBuilderRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAppBlockBuilderRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<AccessEndpoint>	accessEndpoints() The list of interface VPC endpoint (interface endpoint) objects.
static CreateAppBlockBuilderRequest.Builder	builder()
String	description() The description of the app block builder.
String	displayName() The display name of the app block builder.
Boolean	enableDefaultInternetAccess() Enables or disables default internet access for the app block builder.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAccessEndpoints() For responses, this returns true if the service returned a value for the AccessEndpoints property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	iamRoleArn() The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder.
String	instanceType() The instance type to use when launching the app block builder.
String	name() The unique name for the app block builder.
AppBlockBuilderPlatformType	platform() The platform of the app block builder.
String	platformAsString() The platform of the app block builder.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAppBlockBuilderRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() The tags to associate with the app block builder.
CreateAppBlockBuilderRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
VpcConfig	vpcConfig() The VPC configuration for the app block builder.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

The unique name for the app block builder.

Returns:

The unique name for the app block builder.

description

public final String description()

The description of the app block builder.

Returns:

The description of the app block builder.

displayName

public final String displayName()

The display name of the app block builder.

Returns:

The display name of the app block builder.

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 app block builder. 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, 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 app block builder. 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, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

platform

public final AppBlockBuilderPlatformType platform()

The platform of the app block builder.

WINDOWS_SERVER_2019 is the only valid value.

If the service returns an enum value that is not available in the current SDK version, platform will return AppBlockBuilderPlatformType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

Returns:

The platform of the app block builder.

WINDOWS_SERVER_2019 is the only valid value.

See Also:

AppBlockBuilderPlatformType

platformAsString

public final String platformAsString()

The platform of the app block builder.

WINDOWS_SERVER_2019 is the only valid value.

If the service returns an enum value that is not available in the current SDK version, platform will return AppBlockBuilderPlatformType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

Returns:

The platform of the app block builder.

WINDOWS_SERVER_2019 is the only valid value.

See Also:

AppBlockBuilderPlatformType

instanceType

public final String instanceType()

The instance type to use when launching the app block builder. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.standard.xlarge

• stream.standard.2xlarge

Returns:

The instance type to use when launching the app block builder. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.standard.xlarge

• stream.standard.2xlarge

vpcConfig

public final VpcConfig vpcConfig()

The VPC configuration for the app block builder.

App block builders require that you specify at least two subnets in different availability zones.

Returns:

The VPC configuration for the app block builder.

App block builders require that you specify at least two subnets in different availability zones.

enableDefaultInternetAccess

public final Boolean enableDefaultInternetAccess()

Enables or disables default internet access for the app block builder.

Returns:

Enables or disables default internet access for the app block builder.

iamRoleArn

public final String iamRoleArn()

The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

Returns:

The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances 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. Administrators can connect to the app block builder 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. Administrators can connect to the app block builder only through the specified endpoints.

toBuilder

public CreateAppBlockBuilderRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAppBlockBuilderRequest.Builder,CreateAppBlockBuilderRequest>

Specified by:

toBuilder in class AppStreamRequest

builder

public static CreateAppBlockBuilderRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo