NAME
Paws::Snowball::CreateCluster - Arguments for method CreateCluster on Paws::Snowball
DESCRIPTION
This class represents the parameters used for calling the method CreateCluster on the Amazon Import/Export Snowball service. Use the attributes of this class as arguments to method CreateCluster.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCluster.
SYNOPSIS
my $snowball = Paws->service('Snowball');
# To create a cluster
# Creates an empty cluster. Each cluster supports five nodes. You use the
# CreateJob action separately to create the jobs for each of these nodes. The
# cluster does not ship until these five node jobs have been created.
my $CreateClusterResult = $snowball->CreateCluster(
'AddressId' => 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
'Description' => 'MyCluster',
'JobType' => 'LOCAL_USE',
'KmsKeyARN' =>
'arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456',
'Notification' => {
'JobStatesToNotify' => [
],
'NotifyAll' => 0
},
'Resources' => {
'S3Resources' => [
{
'BucketArn' => 'arn:aws:s3:::MyBucket',
'KeyRange' => {
}
}
]
},
'RoleARN' => 'arn:aws:iam::123456789012:role/snowball-import-S3-role',
'ShippingOption' => 'SECOND_DAY',
'SnowballType' => 'EDGE'
);
# Results:
my $ClusterId = $CreateClusterResult->ClusterId;
# Returns a L<Paws::Snowball::CreateClusterResult> 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/snowball/CreateCluster
ATTRIBUTES
REQUIRED AddressId => Str
The ID for the address that you want the cluster shipped to.
Description => Str
An optional description of this specific cluster, for example Environmental Data Cluster-01.
ForwardingAddressId => Str
The forwarding address ID for a cluster. This field is not supported in most regions.
REQUIRED JobType => Str
The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
Valid values are: "IMPORT", "EXPORT", "LOCAL_USE"
KmsKeyARN => Str
The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) API action in AWS Key Management Service (AWS KMS).
Notification => Paws::Snowball::Notification
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
OnDeviceServiceConfiguration => Paws::Snowball::OnDeviceServiceConfiguration
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).
RemoteManagement => Str
Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.
Valid values are: "INSTALLED_ONLY", "INSTALLED_AUTOSTART"
REQUIRED Resources => Paws::Snowball::JobResource
The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language.
REQUIRED RoleARN => Str
The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) API action in AWS Identity and Access Management (IAM).
REQUIRED ShippingOption => Str
The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:
In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
In India, Snow devices are delivered in one to seven days.
In the United States of America (US), you have access to one-day shipping and two-day shipping.
In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
In India, Snow devices are delivered in one to seven days.
In the US, you have access to one-day shipping and two-day shipping.
Valid values are: "SECOND_DAY", "NEXT_DAY", "EXPRESS", "STANDARD"
REQUIRED SnowballType => Str
The type of AWS Snow Family device to use for this cluster.
For cluster jobs, AWS Snow Family currently supports only the EDGE device type.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
Valid values are: "STANDARD", "EDGE", "EDGE_C", "EDGE_CG", "EDGE_S", "SNC1_HDD", "SNC1_SSD"
TaxDocuments => Paws::Snowball::TaxDocuments
The tax documents required in your AWS Region.
SEE ALSO
This class forms part of Paws, documenting arguments for method CreateCluster in Paws::Snowball
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