Update App Block Builder
appstream_update_app_block_builder | R Documentation |
Updates an app block builder¶
Description¶
Updates an app block builder.
If the app block builder is in the STARTING
or STOPPING
state, you
can't update it. If the app block builder is in the RUNNING
state, you
can only update the DisplayName and Description. If the app block
builder is in the STOPPED
state, you can update any attribute except
the Name.
Usage¶
appstream_update_app_block_builder(Name, Description, DisplayName,
Platform, InstanceType, VpcConfig, EnableDefaultInternetAccess,
IamRoleArn, AccessEndpoints, AttributesToDelete)
Arguments¶
Name
[required] The unique name for the app block builder.
Description
The description of the app block builder.
DisplayName
The display name of the app block builder.
Platform
The platform of the app block builder.
WINDOWS_SERVER_2019
is the only valid value.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
VpcConfig
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.
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.
AccessEndpoints
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
AttributesToDelete
The attributes to delete from the app block builder.
Value¶
A list with the following syntax:
list(
AppBlockBuilder = list(
Arn = "string",
Name = "string",
DisplayName = "string",
Description = "string",
Platform = "WINDOWS_SERVER_2019",
InstanceType = "string",
EnableDefaultInternetAccess = TRUE|FALSE,
IamRoleArn = "string",
VpcConfig = list(
SubnetIds = list(
"string"
),
SecurityGroupIds = list(
"string"
)
),
State = "STARTING"|"RUNNING"|"STOPPING"|"STOPPED",
CreatedTime = as.POSIXct(
"2015-01-01"
),
AppBlockBuilderErrors = list(
list(
ErrorCode = "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION"|"IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION"|"IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION"|"NETWORK_INTERFACE_LIMIT_EXCEEDED"|"INTERNAL_SERVICE_ERROR"|"IAM_SERVICE_ROLE_IS_MISSING"|"MACHINE_ROLE_IS_MISSING"|"STS_DISABLED_IN_REGION"|"SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES"|"IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION"|"SUBNET_NOT_FOUND"|"IMAGE_NOT_FOUND"|"INVALID_SUBNET_CONFIGURATION"|"SECURITY_GROUPS_NOT_FOUND"|"IGW_NOT_ATTACHED"|"IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION"|"FLEET_STOPPED"|"FLEET_INSTANCE_PROVISIONING_FAILURE"|"DOMAIN_JOIN_ERROR_FILE_NOT_FOUND"|"DOMAIN_JOIN_ERROR_ACCESS_DENIED"|"DOMAIN_JOIN_ERROR_LOGON_FAILURE"|"DOMAIN_JOIN_ERROR_INVALID_PARAMETER"|"DOMAIN_JOIN_ERROR_MORE_DATA"|"DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN"|"DOMAIN_JOIN_ERROR_NOT_SUPPORTED"|"DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME"|"DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED"|"DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED"|"DOMAIN_JOIN_NERR_PASSWORD_EXPIRED"|"DOMAIN_JOIN_INTERNAL_SERVICE_ERROR",
ErrorMessage = "string",
ErrorTimestamp = as.POSIXct(
"2015-01-01"
)
)
),
StateChangeReason = list(
Code = "INTERNAL_ERROR",
Message = "string"
),
AccessEndpoints = list(
list(
EndpointType = "STREAMING",
VpceId = "string"
)
)
)
)
Request syntax¶
svc$update_app_block_builder(
Name = "string",
Description = "string",
DisplayName = "string",
Platform = "WINDOWS"|"WINDOWS_SERVER_2016"|"WINDOWS_SERVER_2019"|"WINDOWS_SERVER_2022"|"AMAZON_LINUX2"|"RHEL8",
InstanceType = "string",
VpcConfig = list(
SubnetIds = list(
"string"
),
SecurityGroupIds = list(
"string"
)
),
EnableDefaultInternetAccess = TRUE|FALSE,
IamRoleArn = "string",
AccessEndpoints = list(
list(
EndpointType = "STREAMING",
VpceId = "string"
)
),
AttributesToDelete = list(
"IAM_ROLE_ARN"|"ACCESS_ENDPOINTS"|"VPC_CONFIGURATION_SECURITY_GROUP_IDS"
)
)