Package org.jclouds.ec2.features

Interface WindowsApi

public interface WindowsApi

Provides access to EC2 Windows Features via the Query API

See Also:

doc

Method Summary

Modifier and Type	Method	Description
BundleTask	bundleInstanceInRegion(String region, String instanceId, String prefix, String bucket, String uploadPolicy, BundleInstanceS3StorageOptions... options)	Bundles the Windows instance.
BundleTask	cancelBundleTaskInRegion(String region, String bundleId)	Cancels an Amazon EC2 bundling operation.
Set<BundleTask>	describeBundleTasksInRegion(String region, String... bundleTaskIds)	Describes current bundling tasks.
Set<BundleTask>	describeBundleTasksInRegionWithFilter(String region, com.google.common.collect.Multimap<String,String> filter)	Describes current bundling tasks.
PasswordData	getPasswordDataForInstance(String instanceId)	Retrieves the encrypted administrator password for the instances running Windows.
PasswordData	getPasswordDataInRegion(String region, String instanceId)	Retrieves the encrypted administrator password for the instances running Windows.

Method Detail

bundleInstanceInRegion

@Named("BundleInstance")
@POST
@Path("/")
BundleTask bundleInstanceInRegion(@Nullable
                                  String region,
                                  @FormParam("InstanceId")
                                  String instanceId,
                                  @FormParam("Storage.S3.Prefix")
                                  String prefix,
                                  @FormParam("Storage.S3.Bucket")
                                  String bucket,
                                  String uploadPolicy,
                                  BundleInstanceS3StorageOptions... options)

Bundles the Windows instance. This procedure is not applicable for Linux and UNIX instances. For more information, go to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud Getting Started Guide.

Parameters:

region - Bundles are tied to the Region where its files are located within Amazon S3.

instanceId - The ID of the instance to bundle.

prefix - Specifies the beginning of the file name of the AMI.

bucket - The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

uploadPolicy - An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on the user's behalf.

ex.

 {"expiration": "2008-08-30T08:49:09Z","conditions": ["bucket": "my-bucket"},["starts-with", "$key", "my-new-image"]]}
 

options - if the bucket isn't owned by you, use this to set the bucket's accesskeyid

Returns:

status of the work

See Also:

cancelBundleTaskInRegion(java.lang.String, java.lang.String), describeBundleTasksInRegion(java.lang.String, java.lang.String...),

cancelBundleTaskInRegion

@Named("CancelBundleTask")
@POST
@Path("/")
BundleTask cancelBundleTaskInRegion(@Nullable
                                    String region,
                                    @FormParam("BundleId")
                                    String bundleId)

Cancels an Amazon EC2 bundling operation.

Parameters:

region - The bundleTask ID is tied to the Region.

bundleId - The ID of the bundle task to cancel.

Returns:

task for the cancel.

See Also:

bundleInstanceInRegion(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, org.jclouds.ec2.options.BundleInstanceS3StorageOptions...), describeBundleTasksInRegion(java.lang.String, java.lang.String...),

describeBundleTasksInRegion

@Named("DescribeBundleTasks")
@POST
@Path("/")
Set<BundleTask> describeBundleTasksInRegion(@Nullable
                                            String region,
                                            String... bundleTaskIds)

Describes current bundling tasks.

Parameters:

region - The bundleTask ID is tied to the Region.

See Also:

cancelBundleTaskInRegion(java.lang.String, java.lang.String), bundleInstanceInRegion(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, org.jclouds.ec2.options.BundleInstanceS3StorageOptions...),

describeBundleTasksInRegionWithFilter

@Named("DescribeBundleTasks")
@POST
@Path("/")
Set<BundleTask> describeBundleTasksInRegionWithFilter(@Nullable
                                                      String region,
                                                      com.google.common.collect.Multimap<String,String> filter)

Describes current bundling tasks.

Parameters:

region - The bundleTask ID is tied to the Region.

filter - Filter multimap

See Also:

cancelBundleTaskInRegion(java.lang.String, java.lang.String), bundleInstanceInRegion(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, org.jclouds.ec2.options.BundleInstanceS3StorageOptions...),

getPasswordDataInRegion

@Named("GetPasswordData")
@POST
@Path("/")
PasswordData getPasswordDataInRegion(@Nullable
                                     String region,
                                     @FormParam("InstanceId")
                                     String instanceId)

Retrieves the encrypted administrator password for the instances running Windows.

Parameters:

region - The region where the instance is based

instanceId - The ID of the instance to query

See Also:

getPasswordDataForInstance

@Named("GetPasswordData")
@POST
@Path("/")
PasswordData getPasswordDataForInstance(@FormParam("InstanceId")
                                        String instanceId)

Retrieves the encrypted administrator password for the instances running Windows.

Note

The Windows password is only generated the first time an AMI is launched. It is not generated for rebundled AMIs or after the password is changed on an instance. The password is encrypted using the key pair that you provided.

Parameters:

instanceId - The ID of the instance to query

Returns:

password data or null if not available

See Also: