NAME
Paws::AppStream::CreateImageBuilder - Arguments for method CreateImageBuilder on Paws::AppStream
DESCRIPTION
This class represents the parameters used for calling the method CreateImageBuilder on the Amazon AppStream service. Use the attributes of this class as arguments to method CreateImageBuilder.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateImageBuilder.
SYNOPSIS
my $appstream2 = Paws->service('AppStream');
my $CreateImageBuilderResult = $appstream2->CreateImageBuilder(
InstanceType => 'MyString',
Name => 'MyName',
AccessEndpoints => [
{
EndpointType => 'STREAMING', # values: STREAMING
VpceId => 'MyString', # min: 1
},
...
], # OPTIONAL
AppstreamAgentVersion => 'MyAppstreamAgentVersion', # OPTIONAL
Description => 'MyDescription', # OPTIONAL
DisplayName => 'MyDisplayName', # OPTIONAL
DomainJoinInfo => {
DirectoryName => 'MyDirectoryName', # OPTIONAL
OrganizationalUnitDistinguishedName =>
'MyOrganizationalUnitDistinguishedName', # max: 2000; OPTIONAL
}, # OPTIONAL
EnableDefaultInternetAccess => 1, # OPTIONAL
IamRoleArn => 'MyArn', # OPTIONAL
ImageArn => 'MyArn', # OPTIONAL
ImageName => 'MyString', # OPTIONAL
Tags => {
'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256
}, # OPTIONAL
VpcConfig => {
SecurityGroupIds => [
'MyString', ... # min: 1
], # max: 5; OPTIONAL
SubnetIds => [
'MyString', ... # min: 1
], # OPTIONAL
}, # OPTIONAL
);
# Results:
my $ImageBuilder = $CreateImageBuilderResult->ImageBuilder;
# Returns a L<Paws::AppStream::CreateImageBuilderResult> object.Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/appstream2/CreateImageBuilder
ATTRIBUTES
AccessEndpoints => ArrayRef[Paws::AppStream::AccessEndpoint]
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.
AppstreamAgentVersion => Str
The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
Description => Str
The description to display.
DisplayName => Str
The image builder name to display.
DomainJoinInfo => Paws::AppStream::DomainJoinInfo
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
EnableDefaultInternetAccess => Bool
Enables or disables default internet access for the image builder.
IamRoleArn => Str
The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image 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 (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) in the Amazon AppStream 2.0 Administration Guide.
ImageArn => Str
The ARN of the public, private, or shared image to use.
ImageName => Str
The name of the image used to create the image builder.
REQUIRED InstanceType => Str
The instance type to use when launching the image builder. The following instance types are available:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.compute.large
stream.compute.xlarge
stream.compute.2xlarge
stream.compute.4xlarge
stream.compute.8xlarge
stream.memory.large
stream.memory.xlarge
stream.memory.2xlarge
stream.memory.4xlarge
stream.memory.8xlarge
stream.memory.z1d.large
stream.memory.z1d.xlarge
stream.memory.z1d.2xlarge
stream.memory.z1d.3xlarge
stream.memory.z1d.6xlarge
stream.memory.z1d.12xlarge
stream.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge
REQUIRED Name => Str
A unique name for the image builder.
Tags => Paws::AppStream::Tags
The tags to associate with the image 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=.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
_ . : / = + \ - @
If you do not specify a value, the value is set to an empty string.
For more information about tags, see Tagging Your Resources (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) in the Amazon AppStream 2.0 Administration Guide.
VpcConfig => Paws::AppStream::VpcConfig
The VPC configuration for the image builder. You can specify only one subnet.
SEE ALSO
This class forms part of Paws, documenting arguments for method CreateImageBuilder in Paws::AppStream
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues