Class CreateAppBlockBuilderRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateAppBlockBuilderRequest.Builder,
CreateAppBlockBuilderRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<AccessEndpoint> The list of interface VPC endpoint (interface endpoint) objects.builder()
final String
The description of the app block builder.final String
The display name of the app block builder.final Boolean
Enables or disables default internet access for the app block builder.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AccessEndpoints property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder.final String
The instance type to use when launching the app block builder.final String
name()
The unique name for the app block builder.platform()
The platform of the app block builder.final String
The platform of the app block builder.static Class
<? extends CreateAppBlockBuilderRequest.Builder> tags()
The tags to associate with the app block builder.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 VpcConfig
The VPC configuration for the app block builder.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The unique name for the app block builder.
- Returns:
- The unique name for the app block builder.
-
description
The description of the app block builder.
- Returns:
- The description of the app block builder.
-
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 theisEmpty()
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
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
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 returnAppBlockBuilderPlatformType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The platform of the app block builder.
WINDOWS_SERVER_2019
is the only valid value. - See Also:
-
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 returnAppBlockBuilderPlatformType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The platform of the app block builder.
WINDOWS_SERVER_2019
is the only valid value. - See Also:
-
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
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
Enables or disables default internet access for the app block builder.
- Returns:
- Enables or disables default internet access for the app block builder.
-
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 theisEmpty()
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
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
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<CreateAppBlockBuilderRequest.Builder,
CreateAppBlockBuilderRequest> - Specified by:
toBuilder
in classAppStreamRequest
- 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
-