/AWS1/CL_SNBCLUSTERMETADATA¶
Contains metadata about a specific cluster.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_clusterid TYPE /AWS1/SNBSTRING /AWS1/SNBSTRING¶
The automatically generated ID for a cluster.
iv_description TYPE /AWS1/SNBSTRING /AWS1/SNBSTRING¶
The optional description of the cluster.
iv_kmskeyarn TYPE /AWS1/SNBKMSKEYARN /AWS1/SNBKMSKEYARN¶
The
KmsKeyARNAmazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in Key Management Service (KMS.
iv_rolearn TYPE /AWS1/SNBROLEARN /AWS1/SNBROLEARN¶
The role ARN associated with this cluster. This ARN was created using the CreateRole API action in Identity and Access Management (IAM).
iv_clusterstate TYPE /AWS1/SNBCLUSTERSTATE /AWS1/SNBCLUSTERSTATE¶
The current status of the cluster.
iv_jobtype TYPE /AWS1/SNBJOBTYPE /AWS1/SNBJOBTYPE¶
The type of job for this cluster. Currently, the only job type supported for clusters is
LOCAL_USE.
iv_snowballtype TYPE /AWS1/SNBSNOWBALLTYPE /AWS1/SNBSNOWBALLTYPE¶
The type of Snowcone device to use for this cluster.
For cluster jobs, Amazon Web Services Snow Family currently supports only the
EDGEdevice type.
iv_creationdate TYPE /AWS1/SNBTIMESTAMP /AWS1/SNBTIMESTAMP¶
The creation date for this cluster.
io_resources TYPE REF TO /AWS1/CL_SNBJOBRESOURCE /AWS1/CL_SNBJOBRESOURCE¶
The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
iv_addressid TYPE /AWS1/SNBADDRESSID /AWS1/SNBADDRESSID¶
The automatically generated ID for a specific address.
iv_shippingoption TYPE /AWS1/SNBSHIPPINGOPTION /AWS1/SNBSHIPPINGOPTION¶
The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each 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, 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.
io_notification TYPE REF TO /AWS1/CL_SNBNOTIFICATION /AWS1/CL_SNBNOTIFICATION¶
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
iv_forwardingaddressid TYPE /AWS1/SNBADDRESSID /AWS1/SNBADDRESSID¶
The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.
io_taxdocuments TYPE REF TO /AWS1/CL_SNBTAXDOCUMENTS /AWS1/CL_SNBTAXDOCUMENTS¶
The tax documents required in your Amazon Web Services Region.
io_ondeviceserviceconf TYPE REF TO /AWS1/CL_SNBONDEVICESVCCONF /AWS1/CL_SNBONDEVICESVCCONF¶
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
Queryable Attributes¶
ClusterId¶
The automatically generated ID for a cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLUSTERID() |
Getter for CLUSTERID, with configurable default |
ASK_CLUSTERID() |
Getter for CLUSTERID w/ exceptions if field has no value |
HAS_CLUSTERID() |
Determine if CLUSTERID has a value |
Description¶
The optional description of the cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
KmsKeyARN¶
The
KmsKeyARNAmazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in Key Management Service (KMS.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KMSKEYARN() |
Getter for KMSKEYARN, with configurable default |
ASK_KMSKEYARN() |
Getter for KMSKEYARN w/ exceptions if field has no value |
HAS_KMSKEYARN() |
Determine if KMSKEYARN has a value |
RoleARN¶
The role ARN associated with this cluster. This ARN was created using the CreateRole API action in Identity and Access Management (IAM).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
ClusterState¶
The current status of the cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLUSTERSTATE() |
Getter for CLUSTERSTATE, with configurable default |
ASK_CLUSTERSTATE() |
Getter for CLUSTERSTATE w/ exceptions if field has no value |
HAS_CLUSTERSTATE() |
Determine if CLUSTERSTATE has a value |
JobType¶
The type of job for this cluster. Currently, the only job type supported for clusters is
LOCAL_USE.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBTYPE() |
Getter for JOBTYPE, with configurable default |
ASK_JOBTYPE() |
Getter for JOBTYPE w/ exceptions if field has no value |
HAS_JOBTYPE() |
Determine if JOBTYPE has a value |
SnowballType¶
The type of Snowcone device to use for this cluster.
For cluster jobs, Amazon Web Services Snow Family currently supports only the
EDGEdevice type.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SNOWBALLTYPE() |
Getter for SNOWBALLTYPE, with configurable default |
ASK_SNOWBALLTYPE() |
Getter for SNOWBALLTYPE w/ exceptions if field has no value |
HAS_SNOWBALLTYPE() |
Determine if SNOWBALLTYPE has a value |
CreationDate¶
The creation date for this cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONDATE() |
Getter for CREATIONDATE, with configurable default |
ASK_CREATIONDATE() |
Getter for CREATIONDATE w/ exceptions if field has no value |
HAS_CREATIONDATE() |
Determine if CREATIONDATE has a value |
Resources¶
The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCES() |
Getter for RESOURCES |
AddressId¶
The automatically generated ID for a specific address.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ADDRESSID() |
Getter for ADDRESSID, with configurable default |
ASK_ADDRESSID() |
Getter for ADDRESSID w/ exceptions if field has no value |
HAS_ADDRESSID() |
Determine if ADDRESSID has a value |
ShippingOption¶
The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each 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, 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SHIPPINGOPTION() |
Getter for SHIPPINGOPTION, with configurable default |
ASK_SHIPPINGOPTION() |
Getter for SHIPPINGOPTION w/ exceptions if field has no valu |
HAS_SHIPPINGOPTION() |
Determine if SHIPPINGOPTION has a value |
Notification¶
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NOTIFICATION() |
Getter for NOTIFICATION |
ForwardingAddressId¶
The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FORWARDINGADDRESSID() |
Getter for FORWARDINGADDRESSID, with configurable default |
ASK_FORWARDINGADDRESSID() |
Getter for FORWARDINGADDRESSID w/ exceptions if field has no |
HAS_FORWARDINGADDRESSID() |
Determine if FORWARDINGADDRESSID has a value |
TaxDocuments¶
The tax documents required in your Amazon Web Services Region.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAXDOCUMENTS() |
Getter for TAXDOCUMENTS |
OnDeviceServiceConfiguration¶
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ONDEVICESERVICECONF() |
Getter for ONDEVICESERVICECONFIGURATION |