« blib/lib/Paws/AppStream/Image.pm
↑ Summary
blib/lib/Paws/AppStream/ImageBuilderStateChangeReason.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AppStream::ImageBuilder; | ||
| 3 | use Moose; | ||
| 4 | has AccessEndpoints => (is => 'ro', isa => 'ArrayRef[Paws::AppStream::AccessEndpoint]'); | ||
| 5 | has AppstreamAgentVersion => (is => 'ro', isa => 'Str'); | ||
| 6 | has Arn => (is => 'ro', isa => 'Str'); | ||
| 7 | has CreatedTime => (is => 'ro', isa => 'Str'); | ||
| 8 | has Description => (is => 'ro', isa => 'Str'); | ||
| 9 | has DisplayName => (is => 'ro', isa => 'Str'); | ||
| 10 | has DomainJoinInfo => (is => 'ro', isa => 'Paws::AppStream::DomainJoinInfo'); | ||
| 11 | has EnableDefaultInternetAccess => (is => 'ro', isa => 'Bool'); | ||
| 12 | has IamRoleArn => (is => 'ro', isa => 'Str'); | ||
| 13 | has ImageArn => (is => 'ro', isa => 'Str'); | ||
| 14 | has ImageBuilderErrors => (is => 'ro', isa => 'ArrayRef[Paws::AppStream::ResourceError]'); | ||
| 15 | has InstanceType => (is => 'ro', isa => 'Str'); | ||
| 16 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 17 | has NetworkAccessConfiguration => (is => 'ro', isa => 'Paws::AppStream::NetworkAccessConfiguration'); | ||
| 18 | has Platform => (is => 'ro', isa => 'Str'); | ||
| 19 | has State => (is => 'ro', isa => 'Str'); | ||
| 20 | has StateChangeReason => (is => 'ro', isa => 'Paws::AppStream::ImageBuilderStateChangeReason'); | ||
| 21 | has VpcConfig => (is => 'ro', isa => 'Paws::AppStream::VpcConfig'); | ||
| 22 | |||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::AppStream::ImageBuilder | ||
| 30 | |||
| 31 | =head1 USAGE | ||
| 32 | |||
| 33 | This class represents one of two things: | ||
| 34 | |||
| 35 | =head3 Arguments in a call to a service | ||
| 36 | |||
| 37 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 38 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 39 | |||
| 40 | As an example, if Att1 is expected to be a Paws::AppStream::ImageBuilder object: | ||
| 41 | |||
| 42 | $service_obj->Method(Att1 => { AccessEndpoints => $value, ..., VpcConfig => $value }); | ||
| 43 | |||
| 44 | =head3 Results returned from an API call | ||
| 45 | |||
| 46 | Use accessors for each attribute. If Att1 is expected to be an Paws::AppStream::ImageBuilder object: | ||
| 47 | |||
| 48 | $result = $service_obj->Method(...); | ||
| 49 | $result->Att1->AccessEndpoints | ||
| 50 | |||
| 51 | =head1 DESCRIPTION | ||
| 52 | |||
| 53 | Describes a virtual machine that is used to create an image. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 AccessEndpoints => ArrayRef[L<Paws::AppStream::AccessEndpoint>] | ||
| 59 | |||
| 60 | The list of virtual private cloud (VPC) interface endpoint objects. | ||
| 61 | Administrators can connect to the image builder only through the | ||
| 62 | specified endpoints. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 AppstreamAgentVersion => Str | ||
| 66 | |||
| 67 | The version of the AppStream 2.0 agent that is currently being used by | ||
| 68 | the image builder. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Arn => Str | ||
| 72 | |||
| 73 | The ARN for the image builder. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 CreatedTime => Str | ||
| 77 | |||
| 78 | The time stamp when the image builder was created. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 Description => Str | ||
| 82 | |||
| 83 | The description to display. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 DisplayName => Str | ||
| 87 | |||
| 88 | The image builder name to display. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 DomainJoinInfo => L<Paws::AppStream::DomainJoinInfo> | ||
| 92 | |||
| 93 | The name of the directory and organizational unit (OU) to use to join | ||
| 94 | the image builder to a Microsoft Active Directory domain. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 EnableDefaultInternetAccess => Bool | ||
| 98 | |||
| 99 | Enables or disables default internet access for the image builder. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 IamRoleArn => Str | ||
| 103 | |||
| 104 | The ARN of the IAM role that is applied to the image builder. To assume | ||
| 105 | a role, the image builder calls the AWS Security Token Service (STS) | ||
| 106 | C<AssumeRole> API operation and passes the ARN of the role to use. The | ||
| 107 | operation creates a new session with temporary credentials. AppStream | ||
| 108 | 2.0 retrieves the temporary credentials and creates the | ||
| 109 | B<appstream_machine_role> credential profile on the instance. | ||
| 110 | |||
| 111 | For more information, see Using an IAM Role to Grant Permissions to | ||
| 112 | Applications and Scripts Running on AppStream 2.0 Streaming Instances | ||
| 113 | (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) | ||
| 114 | in the I<Amazon AppStream 2.0 Administration Guide>. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 ImageArn => Str | ||
| 118 | |||
| 119 | The ARN of the image from which this builder was created. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 ImageBuilderErrors => ArrayRef[L<Paws::AppStream::ResourceError>] | ||
| 123 | |||
| 124 | The image builder errors. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 InstanceType => Str | ||
| 128 | |||
| 129 | The instance type for the image builder. The following instance types | ||
| 130 | are available: | ||
| 131 | |||
| 132 | =over | ||
| 133 | |||
| 134 | =item * | ||
| 135 | |||
| 136 | stream.standard.small | ||
| 137 | |||
| 138 | =item * | ||
| 139 | |||
| 140 | stream.standard.medium | ||
| 141 | |||
| 142 | =item * | ||
| 143 | |||
| 144 | stream.standard.large | ||
| 145 | |||
| 146 | =item * | ||
| 147 | |||
| 148 | stream.compute.large | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | stream.compute.xlarge | ||
| 153 | |||
| 154 | =item * | ||
| 155 | |||
| 156 | stream.compute.2xlarge | ||
| 157 | |||
| 158 | =item * | ||
| 159 | |||
| 160 | stream.compute.4xlarge | ||
| 161 | |||
| 162 | =item * | ||
| 163 | |||
| 164 | stream.compute.8xlarge | ||
| 165 | |||
| 166 | =item * | ||
| 167 | |||
| 168 | stream.memory.large | ||
| 169 | |||
| 170 | =item * | ||
| 171 | |||
| 172 | stream.memory.xlarge | ||
| 173 | |||
| 174 | =item * | ||
| 175 | |||
| 176 | stream.memory.2xlarge | ||
| 177 | |||
| 178 | =item * | ||
| 179 | |||
| 180 | stream.memory.4xlarge | ||
| 181 | |||
| 182 | =item * | ||
| 183 | |||
| 184 | stream.memory.8xlarge | ||
| 185 | |||
| 186 | =item * | ||
| 187 | |||
| 188 | stream.memory.z1d.large | ||
| 189 | |||
| 190 | =item * | ||
| 191 | |||
| 192 | stream.memory.z1d.xlarge | ||
| 193 | |||
| 194 | =item * | ||
| 195 | |||
| 196 | stream.memory.z1d.2xlarge | ||
| 197 | |||
| 198 | =item * | ||
| 199 | |||
| 200 | stream.memory.z1d.3xlarge | ||
| 201 | |||
| 202 | =item * | ||
| 203 | |||
| 204 | stream.memory.z1d.6xlarge | ||
| 205 | |||
| 206 | =item * | ||
| 207 | |||
| 208 | stream.memory.z1d.12xlarge | ||
| 209 | |||
| 210 | =item * | ||
| 211 | |||
| 212 | stream.graphics-design.large | ||
| 213 | |||
| 214 | =item * | ||
| 215 | |||
| 216 | stream.graphics-design.xlarge | ||
| 217 | |||
| 218 | =item * | ||
| 219 | |||
| 220 | stream.graphics-design.2xlarge | ||
| 221 | |||
| 222 | =item * | ||
| 223 | |||
| 224 | stream.graphics-design.4xlarge | ||
| 225 | |||
| 226 | =item * | ||
| 227 | |||
| 228 | stream.graphics-desktop.2xlarge | ||
| 229 | |||
| 230 | =item * | ||
| 231 | |||
| 232 | stream.graphics.g4dn.xlarge | ||
| 233 | |||
| 234 | =item * | ||
| 235 | |||
| 236 | stream.graphics.g4dn.2xlarge | ||
| 237 | |||
| 238 | =item * | ||
| 239 | |||
| 240 | stream.graphics.g4dn.4xlarge | ||
| 241 | |||
| 242 | =item * | ||
| 243 | |||
| 244 | stream.graphics.g4dn.8xlarge | ||
| 245 | |||
| 246 | =item * | ||
| 247 | |||
| 248 | stream.graphics.g4dn.12xlarge | ||
| 249 | |||
| 250 | =item * | ||
| 251 | |||
| 252 | stream.graphics.g4dn.16xlarge | ||
| 253 | |||
| 254 | =item * | ||
| 255 | |||
| 256 | stream.graphics-pro.4xlarge | ||
| 257 | |||
| 258 | =item * | ||
| 259 | |||
| 260 | stream.graphics-pro.8xlarge | ||
| 261 | |||
| 262 | =item * | ||
| 263 | |||
| 264 | stream.graphics-pro.16xlarge | ||
| 265 | |||
| 266 | =back | ||
| 267 | |||
| 268 | |||
| 269 | |||
| 270 | =head2 B<REQUIRED> Name => Str | ||
| 271 | |||
| 272 | The name of the image builder. | ||
| 273 | |||
| 274 | |||
| 275 | =head2 NetworkAccessConfiguration => L<Paws::AppStream::NetworkAccessConfiguration> | ||
| 276 | |||
| 277 | |||
| 278 | |||
| 279 | |||
| 280 | =head2 Platform => Str | ||
| 281 | |||
| 282 | The operating system platform of the image builder. | ||
| 283 | |||
| 284 | |||
| 285 | =head2 State => Str | ||
| 286 | |||
| 287 | The state of the image builder. | ||
| 288 | |||
| 289 | |||
| 290 | =head2 StateChangeReason => L<Paws::AppStream::ImageBuilderStateChangeReason> | ||
| 291 | |||
| 292 | The reason why the last state change occurred. | ||
| 293 | |||
| 294 | |||
| 295 | =head2 VpcConfig => L<Paws::AppStream::VpcConfig> | ||
| 296 | |||
| 297 | The VPC configuration of the image builder. | ||
| 298 | |||
| 299 | |||
| 300 | |||
| 301 | =head1 SEE ALSO | ||
| 302 | |||
| 303 | This class forms part of L<Paws>, describing an object used in L<Paws::AppStream> | ||
| 304 | |||
| 305 | =head1 BUGS and CONTRIBUTIONS | ||
| 306 | |||
| 307 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 308 | |||
| 309 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 310 | |||
| 311 | =cut | ||
| 312 |