--- title: Getting Started with Datadog description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog --- # aws_snowball_cluster{% #aws_snowball_cluster %} ## `account_id`{% #account_id %} **Type**: `STRING` ## `address_id`{% #address_id %} **Type**: `STRING`**Provider name**: `AddressId`**Description**: The automatically generated ID for a specific address. ## `cluster_id`{% #cluster_id %} **Type**: `STRING`**Provider name**: `ClusterId`**Description**: The automatically generated ID for a cluster. ## `cluster_state`{% #cluster_state %} **Type**: `STRING`**Provider name**: `ClusterState`**Description**: The current status of the cluster. ## `creation_date`{% #creation_date %} **Type**: `TIMESTAMP`**Provider name**: `CreationDate`**Description**: The creation date for this cluster. ## `description`{% #description %} **Type**: `STRING`**Provider name**: `Description`**Description**: The optional description of the cluster. ## `forwarding_address_id`{% #forwarding_address_id %} **Type**: `STRING`**Provider name**: `ForwardingAddressId`**Description**: 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. ## `job_type`{% #job_type %} **Type**: `STRING`**Provider name**: `JobType`**Description**: The type of job for this cluster. Currently, the only job type supported for clusters is `LOCAL_USE`. ## `kms_key_arn`{% #kms_key_arn %} **Type**: `STRING`**Provider name**: `KmsKeyARN`**Description**: The `KmsKeyARN` Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the [CreateKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) API action in Key Management Service (KMS. ## `notification`{% #notification %} **Type**: `STRUCT`**Provider name**: `Notification`**Description**: The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster. - `device_pickup_sns_topic_arn`**Type**: `STRING`**Provider name**: `DevicePickupSnsTopicARN`**Description**: Used to send SNS notifications for the person picking up the device (identified during job creation). - `job_states_to_notify`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `JobStatesToNotify`**Description**: The list of job states that will trigger a notification for this job. - `notify_all`**Type**: `BOOLEAN`**Provider name**: `NotifyAll`**Description**: Any change in job state will trigger a notification for this job. - `sns_topic_arn`**Type**: `STRING`**Provider name**: `SnsTopicARN`**Description**: The new SNS `TopicArn` that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the [CreateTopic](https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html) Amazon SNS API action. You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) Amazon Simple Notification Service (Amazon SNS) API action. ## `on_device_service_configuration`{% #on_device_service_configuration %} **Type**: `STRUCT`**Provider name**: `OnDeviceServiceConfiguration`**Description**: Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device. - `eks_on_device_service`**Type**: `STRUCT`**Provider name**: `EKSOnDeviceService`**Description**: The configuration of EKS Anywhere on the Snow Family device. - `eks_anywhere_version`**Type**: `STRING`**Provider name**: `EKSAnywhereVersion`**Description**: The optional version of EKS Anywhere on the Snow Family device. - `kubernetes_version`**Type**: `STRING`**Provider name**: `KubernetesVersion`**Description**: The Kubernetes version for EKS Anywhere on the Snow Family device. - `nfs_on_device_service`**Type**: `STRUCT`**Provider name**: `NFSOnDeviceService`**Description**: Represents the NFS (Network File System) service on a Snow Family device. - `storage_limit`**Type**: `INT32`**Provider name**: `StorageLimit`**Description**: The maximum NFS storage for one Snow Family device. - `storage_unit`**Type**: `STRING`**Provider name**: `StorageUnit`**Description**: The scale unit of the NFS storage on the device. Valid values: TB. - `s3_on_device_service`**Type**: `STRUCT`**Provider name**: `S3OnDeviceService`**Description**: Configuration for Amazon S3 compatible storage on Snow family devices. - `fault_tolerance`**Type**: `INT32`**Provider name**: `FaultTolerance`**Description**: >Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified `StorageLimit` matches more than one Amazon S3 compatible storage on Snow family devices service configuration. - `service_size`**Type**: `INT32`**Provider name**: `ServiceSize`**Description**: Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted. - `storage_limit`**Type**: `DOUBLE`**Provider name**: `StorageLimit`**Description**: If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided. - `storage_unit`**Type**: `STRING`**Provider name**: `StorageUnit`**Description**: Storage unit. Currently the only supported unit is TB. - `tgw_on_device_service`**Type**: `STRUCT`**Provider name**: `TGWOnDeviceService`**Description**: Represents the Storage Gateway service Tape Gateway type on a Snow Family device. - `storage_limit`**Type**: `INT32`**Provider name**: `StorageLimit`**Description**: The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge. - `storage_unit`**Type**: `STRING`**Provider name**: `StorageUnit`**Description**: The scale unit of the virtual tapes on the device. ## `resources`{% #resources %} **Type**: `STRUCT`**Provider name**: `Resources`**Description**: The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects. - `ec2_ami_resources`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Ec2AmiResources`**Description**: The Amazon Machine Images (AMIs) associated with this job. - `ami_id`**Type**: `STRING`**Provider name**: `AmiId`**Description**: The ID of the AMI in Amazon EC2. - `snowball_ami_id`**Type**: `STRING`**Provider name**: `SnowballAmiId`**Description**: The ID of the AMI on the Snow device. - `lambda_resources`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `LambdaResources`**Description**: The Python-language Lambda functions for this job. - `event_triggers`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `EventTriggers`**Description**: The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job. - `event_resource_arn`**Type**: `STRING`**Provider name**: `EventResourceARN`**Description**: The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job. - `lambda_arn`**Type**: `STRING`**Provider name**: `LambdaArn`**Description**: An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource. - `s3_resources`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `S3Resources`**Description**: An array of `S3Resource` objects. - `bucket_arn`**Type**: `STRING`**Provider name**: `BucketArn`**Description**: The Amazon Resource Name (ARN) of an Amazon S3 bucket. - `key_range`**Type**: `STRUCT`**Provider name**: `KeyRange`**Description**: For export jobs, you can provide an optional `KeyRange` within a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusive `BeginMarker`, an inclusive `EndMarker`, or both. Ranges are UTF-8 binary sorted. - `begin_marker`**Type**: `STRING`**Provider name**: `BeginMarker`**Description**: The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted. - `end_marker`**Type**: `STRING`**Provider name**: `EndMarker`**Description**: The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted. - `target_on_device_services`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `TargetOnDeviceServices`**Description**: Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System). - `service_name`**Type**: `STRING`**Provider name**: `ServiceName`**Description**: Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into. - `transfer_option`**Type**: `STRING`**Provider name**: `TransferOption`**Description**: Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device. ## `role_arn`{% #role_arn %} **Type**: `STRING`**Provider name**: `RoleARN`**Description**: The role ARN associated with this cluster. This ARN was created using the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) API action in Identity and Access Management (IAM). ## `shipping_option`{% #shipping_option %} **Type**: `STRING`**Provider name**: `ShippingOption`**Description**: 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. ## `snowball_type`{% #snowball_type %} **Type**: `STRING`**Provider name**: `SnowballType`**Description**: The type of Snowcone device to use for this cluster.For cluster jobs, Amazon Web Services Snow Family currently supports only the `EDGE` device type. ## `tags`{% #tags %} **Type**: `UNORDERED_LIST_STRING` ## `tax_documents`{% #tax_documents %} **Type**: `STRUCT`**Provider name**: `TaxDocuments`**Description**: The tax documents required in your Amazon Web Services Region. - `ind`**Type**: `STRUCT`**Provider name**: `IND` - `gstin`**Type**: `STRING`**Provider name**: `GSTIN`**Description**: The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.