netapp-cloudmanager.CvoAws
Explore with Pulumi AI
Create CvoAws Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CvoAws(name: string, args: CvoAwsArgs, opts?: CustomResourceOptions);
@overload
def CvoAws(resource_name: str,
args: CvoAwsArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CvoAws(resource_name: str,
opts: Optional[ResourceOptions] = None,
client_id: Optional[str] = None,
region: Optional[str] = None,
svm_password: Optional[str] = None,
assume_role_arn: Optional[str] = None,
aws_encryption_kms_key_arn: Optional[str] = None,
aws_encryption_kms_key_id: Optional[str] = None,
aws_tags: Optional[Sequence[CvoAwsAwsTagArgs]] = None,
backup_volumes_to_cbs: Optional[bool] = None,
capacity_package_name: Optional[str] = None,
capacity_tier: Optional[str] = None,
cloud_provider_account: Optional[str] = None,
cluster_floating_ip: Optional[str] = None,
cluster_key_pair_name: Optional[str] = None,
cvo_aws_id: Optional[str] = None,
data_encryption_type: Optional[str] = None,
data_floating_ip: Optional[str] = None,
data_floating_ip2: Optional[str] = None,
ebs_volume_size: Optional[float] = None,
ebs_volume_size_unit: Optional[str] = None,
ebs_volume_type: Optional[str] = None,
enable_compliance: Optional[bool] = None,
enable_monitoring: Optional[bool] = None,
failover_mode: Optional[str] = None,
instance_profile_name: Optional[str] = None,
instance_tenancy: Optional[str] = None,
instance_type: Optional[str] = None,
iops: Optional[float] = None,
is_ha: Optional[bool] = None,
kms_key_id: Optional[str] = None,
license_type: Optional[str] = None,
mediator_assign_public_ip: Optional[bool] = None,
mediator_instance_profile_name: Optional[str] = None,
mediator_key_pair_name: Optional[str] = None,
mediator_security_group_id: Optional[str] = None,
mediator_subnet_id: Optional[str] = None,
name: Optional[str] = None,
node1_subnet_id: Optional[str] = None,
node2_subnet_id: Optional[str] = None,
nss_account: Optional[str] = None,
ontap_version: Optional[str] = None,
optimized_network_utilization: Optional[bool] = None,
platform_serial_number: Optional[str] = None,
platform_serial_number_node1: Optional[str] = None,
platform_serial_number_node2: Optional[str] = None,
provided_license: Optional[str] = None,
retries: Optional[float] = None,
route_table_ids: Optional[Sequence[str]] = None,
saas_subscription_id: Optional[str] = None,
security_group_id: Optional[str] = None,
subnet_id: Optional[str] = None,
svm_floating_ip: Optional[str] = None,
svm_name: Optional[str] = None,
throughput: Optional[float] = None,
tier_level: Optional[str] = None,
upgrade_ontap_version: Optional[bool] = None,
use_latest_version: Optional[bool] = None,
vpc_id: Optional[str] = None,
workspace_id: Optional[str] = None,
worm_retention_period_length: Optional[float] = None,
worm_retention_period_unit: Optional[str] = None,
writing_speed_state: Optional[str] = None)
func NewCvoAws(ctx *Context, name string, args CvoAwsArgs, opts ...ResourceOption) (*CvoAws, error)
public CvoAws(string name, CvoAwsArgs args, CustomResourceOptions? opts = null)
public CvoAws(String name, CvoAwsArgs args)
public CvoAws(String name, CvoAwsArgs args, CustomResourceOptions options)
type: netapp-cloudmanager:CvoAws
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CvoAwsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CvoAwsArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CvoAwsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CvoAwsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CvoAwsArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var cvoAwsResource = new NetappCloudmanager.CvoAws("cvoAwsResource", new()
{
ClientId = "string",
Region = "string",
SvmPassword = "string",
AssumeRoleArn = "string",
AwsEncryptionKmsKeyArn = "string",
AwsEncryptionKmsKeyId = "string",
AwsTags = new[]
{
new NetappCloudmanager.Inputs.CvoAwsAwsTagArgs
{
TagKey = "string",
TagValue = "string",
},
},
BackupVolumesToCbs = false,
CapacityPackageName = "string",
CapacityTier = "string",
CloudProviderAccount = "string",
ClusterFloatingIp = "string",
ClusterKeyPairName = "string",
CvoAwsId = "string",
DataEncryptionType = "string",
DataFloatingIp = "string",
DataFloatingIp2 = "string",
EbsVolumeSize = 0,
EbsVolumeSizeUnit = "string",
EbsVolumeType = "string",
EnableCompliance = false,
EnableMonitoring = false,
FailoverMode = "string",
InstanceProfileName = "string",
InstanceTenancy = "string",
InstanceType = "string",
Iops = 0,
IsHa = false,
KmsKeyId = "string",
LicenseType = "string",
MediatorAssignPublicIp = false,
MediatorInstanceProfileName = "string",
MediatorKeyPairName = "string",
MediatorSecurityGroupId = "string",
MediatorSubnetId = "string",
Name = "string",
Node1SubnetId = "string",
Node2SubnetId = "string",
NssAccount = "string",
OntapVersion = "string",
OptimizedNetworkUtilization = false,
PlatformSerialNumber = "string",
PlatformSerialNumberNode1 = "string",
PlatformSerialNumberNode2 = "string",
ProvidedLicense = "string",
Retries = 0,
RouteTableIds = new[]
{
"string",
},
SaasSubscriptionId = "string",
SecurityGroupId = "string",
SubnetId = "string",
SvmFloatingIp = "string",
SvmName = "string",
Throughput = 0,
TierLevel = "string",
UpgradeOntapVersion = false,
UseLatestVersion = false,
VpcId = "string",
WorkspaceId = "string",
WormRetentionPeriodLength = 0,
WormRetentionPeriodUnit = "string",
WritingSpeedState = "string",
});
example, err := netappcloudmanager.NewCvoAws(ctx, "cvoAwsResource", &netappcloudmanager.CvoAwsArgs{
ClientId: pulumi.String("string"),
Region: pulumi.String("string"),
SvmPassword: pulumi.String("string"),
AssumeRoleArn: pulumi.String("string"),
AwsEncryptionKmsKeyArn: pulumi.String("string"),
AwsEncryptionKmsKeyId: pulumi.String("string"),
AwsTags: netappcloudmanager.CvoAwsAwsTagArray{
&netappcloudmanager.CvoAwsAwsTagArgs{
TagKey: pulumi.String("string"),
TagValue: pulumi.String("string"),
},
},
BackupVolumesToCbs: pulumi.Bool(false),
CapacityPackageName: pulumi.String("string"),
CapacityTier: pulumi.String("string"),
CloudProviderAccount: pulumi.String("string"),
ClusterFloatingIp: pulumi.String("string"),
ClusterKeyPairName: pulumi.String("string"),
CvoAwsId: pulumi.String("string"),
DataEncryptionType: pulumi.String("string"),
DataFloatingIp: pulumi.String("string"),
DataFloatingIp2: pulumi.String("string"),
EbsVolumeSize: pulumi.Float64(0),
EbsVolumeSizeUnit: pulumi.String("string"),
EbsVolumeType: pulumi.String("string"),
EnableCompliance: pulumi.Bool(false),
EnableMonitoring: pulumi.Bool(false),
FailoverMode: pulumi.String("string"),
InstanceProfileName: pulumi.String("string"),
InstanceTenancy: pulumi.String("string"),
InstanceType: pulumi.String("string"),
Iops: pulumi.Float64(0),
IsHa: pulumi.Bool(false),
KmsKeyId: pulumi.String("string"),
LicenseType: pulumi.String("string"),
MediatorAssignPublicIp: pulumi.Bool(false),
MediatorInstanceProfileName: pulumi.String("string"),
MediatorKeyPairName: pulumi.String("string"),
MediatorSecurityGroupId: pulumi.String("string"),
MediatorSubnetId: pulumi.String("string"),
Name: pulumi.String("string"),
Node1SubnetId: pulumi.String("string"),
Node2SubnetId: pulumi.String("string"),
NssAccount: pulumi.String("string"),
OntapVersion: pulumi.String("string"),
OptimizedNetworkUtilization: pulumi.Bool(false),
PlatformSerialNumber: pulumi.String("string"),
PlatformSerialNumberNode1: pulumi.String("string"),
PlatformSerialNumberNode2: pulumi.String("string"),
ProvidedLicense: pulumi.String("string"),
Retries: pulumi.Float64(0),
RouteTableIds: pulumi.StringArray{
pulumi.String("string"),
},
SaasSubscriptionId: pulumi.String("string"),
SecurityGroupId: pulumi.String("string"),
SubnetId: pulumi.String("string"),
SvmFloatingIp: pulumi.String("string"),
SvmName: pulumi.String("string"),
Throughput: pulumi.Float64(0),
TierLevel: pulumi.String("string"),
UpgradeOntapVersion: pulumi.Bool(false),
UseLatestVersion: pulumi.Bool(false),
VpcId: pulumi.String("string"),
WorkspaceId: pulumi.String("string"),
WormRetentionPeriodLength: pulumi.Float64(0),
WormRetentionPeriodUnit: pulumi.String("string"),
WritingSpeedState: pulumi.String("string"),
})
var cvoAwsResource = new CvoAws("cvoAwsResource", CvoAwsArgs.builder()
.clientId("string")
.region("string")
.svmPassword("string")
.assumeRoleArn("string")
.awsEncryptionKmsKeyArn("string")
.awsEncryptionKmsKeyId("string")
.awsTags(CvoAwsAwsTagArgs.builder()
.tagKey("string")
.tagValue("string")
.build())
.backupVolumesToCbs(false)
.capacityPackageName("string")
.capacityTier("string")
.cloudProviderAccount("string")
.clusterFloatingIp("string")
.clusterKeyPairName("string")
.cvoAwsId("string")
.dataEncryptionType("string")
.dataFloatingIp("string")
.dataFloatingIp2("string")
.ebsVolumeSize(0)
.ebsVolumeSizeUnit("string")
.ebsVolumeType("string")
.enableCompliance(false)
.enableMonitoring(false)
.failoverMode("string")
.instanceProfileName("string")
.instanceTenancy("string")
.instanceType("string")
.iops(0)
.isHa(false)
.kmsKeyId("string")
.licenseType("string")
.mediatorAssignPublicIp(false)
.mediatorInstanceProfileName("string")
.mediatorKeyPairName("string")
.mediatorSecurityGroupId("string")
.mediatorSubnetId("string")
.name("string")
.node1SubnetId("string")
.node2SubnetId("string")
.nssAccount("string")
.ontapVersion("string")
.optimizedNetworkUtilization(false)
.platformSerialNumber("string")
.platformSerialNumberNode1("string")
.platformSerialNumberNode2("string")
.providedLicense("string")
.retries(0)
.routeTableIds("string")
.saasSubscriptionId("string")
.securityGroupId("string")
.subnetId("string")
.svmFloatingIp("string")
.svmName("string")
.throughput(0)
.tierLevel("string")
.upgradeOntapVersion(false)
.useLatestVersion(false)
.vpcId("string")
.workspaceId("string")
.wormRetentionPeriodLength(0)
.wormRetentionPeriodUnit("string")
.writingSpeedState("string")
.build());
cvo_aws_resource = netapp_cloudmanager.CvoAws("cvoAwsResource",
client_id="string",
region="string",
svm_password="string",
assume_role_arn="string",
aws_encryption_kms_key_arn="string",
aws_encryption_kms_key_id="string",
aws_tags=[{
"tag_key": "string",
"tag_value": "string",
}],
backup_volumes_to_cbs=False,
capacity_package_name="string",
capacity_tier="string",
cloud_provider_account="string",
cluster_floating_ip="string",
cluster_key_pair_name="string",
cvo_aws_id="string",
data_encryption_type="string",
data_floating_ip="string",
data_floating_ip2="string",
ebs_volume_size=0,
ebs_volume_size_unit="string",
ebs_volume_type="string",
enable_compliance=False,
enable_monitoring=False,
failover_mode="string",
instance_profile_name="string",
instance_tenancy="string",
instance_type="string",
iops=0,
is_ha=False,
kms_key_id="string",
license_type="string",
mediator_assign_public_ip=False,
mediator_instance_profile_name="string",
mediator_key_pair_name="string",
mediator_security_group_id="string",
mediator_subnet_id="string",
name="string",
node1_subnet_id="string",
node2_subnet_id="string",
nss_account="string",
ontap_version="string",
optimized_network_utilization=False,
platform_serial_number="string",
platform_serial_number_node1="string",
platform_serial_number_node2="string",
provided_license="string",
retries=0,
route_table_ids=["string"],
saas_subscription_id="string",
security_group_id="string",
subnet_id="string",
svm_floating_ip="string",
svm_name="string",
throughput=0,
tier_level="string",
upgrade_ontap_version=False,
use_latest_version=False,
vpc_id="string",
workspace_id="string",
worm_retention_period_length=0,
worm_retention_period_unit="string",
writing_speed_state="string")
const cvoAwsResource = new netapp_cloudmanager.CvoAws("cvoAwsResource", {
clientId: "string",
region: "string",
svmPassword: "string",
assumeRoleArn: "string",
awsEncryptionKmsKeyArn: "string",
awsEncryptionKmsKeyId: "string",
awsTags: [{
tagKey: "string",
tagValue: "string",
}],
backupVolumesToCbs: false,
capacityPackageName: "string",
capacityTier: "string",
cloudProviderAccount: "string",
clusterFloatingIp: "string",
clusterKeyPairName: "string",
cvoAwsId: "string",
dataEncryptionType: "string",
dataFloatingIp: "string",
dataFloatingIp2: "string",
ebsVolumeSize: 0,
ebsVolumeSizeUnit: "string",
ebsVolumeType: "string",
enableCompliance: false,
enableMonitoring: false,
failoverMode: "string",
instanceProfileName: "string",
instanceTenancy: "string",
instanceType: "string",
iops: 0,
isHa: false,
kmsKeyId: "string",
licenseType: "string",
mediatorAssignPublicIp: false,
mediatorInstanceProfileName: "string",
mediatorKeyPairName: "string",
mediatorSecurityGroupId: "string",
mediatorSubnetId: "string",
name: "string",
node1SubnetId: "string",
node2SubnetId: "string",
nssAccount: "string",
ontapVersion: "string",
optimizedNetworkUtilization: false,
platformSerialNumber: "string",
platformSerialNumberNode1: "string",
platformSerialNumberNode2: "string",
providedLicense: "string",
retries: 0,
routeTableIds: ["string"],
saasSubscriptionId: "string",
securityGroupId: "string",
subnetId: "string",
svmFloatingIp: "string",
svmName: "string",
throughput: 0,
tierLevel: "string",
upgradeOntapVersion: false,
useLatestVersion: false,
vpcId: "string",
workspaceId: "string",
wormRetentionPeriodLength: 0,
wormRetentionPeriodUnit: "string",
writingSpeedState: "string",
});
type: netapp-cloudmanager:CvoAws
properties:
assumeRoleArn: string
awsEncryptionKmsKeyArn: string
awsEncryptionKmsKeyId: string
awsTags:
- tagKey: string
tagValue: string
backupVolumesToCbs: false
capacityPackageName: string
capacityTier: string
clientId: string
cloudProviderAccount: string
clusterFloatingIp: string
clusterKeyPairName: string
cvoAwsId: string
dataEncryptionType: string
dataFloatingIp: string
dataFloatingIp2: string
ebsVolumeSize: 0
ebsVolumeSizeUnit: string
ebsVolumeType: string
enableCompliance: false
enableMonitoring: false
failoverMode: string
instanceProfileName: string
instanceTenancy: string
instanceType: string
iops: 0
isHa: false
kmsKeyId: string
licenseType: string
mediatorAssignPublicIp: false
mediatorInstanceProfileName: string
mediatorKeyPairName: string
mediatorSecurityGroupId: string
mediatorSubnetId: string
name: string
node1SubnetId: string
node2SubnetId: string
nssAccount: string
ontapVersion: string
optimizedNetworkUtilization: false
platformSerialNumber: string
platformSerialNumberNode1: string
platformSerialNumberNode2: string
providedLicense: string
region: string
retries: 0
routeTableIds:
- string
saasSubscriptionId: string
securityGroupId: string
subnetId: string
svmFloatingIp: string
svmName: string
svmPassword: string
throughput: 0
tierLevel: string
upgradeOntapVersion: false
useLatestVersion: false
vpcId: string
workspaceId: string
wormRetentionPeriodLength: 0
wormRetentionPeriodUnit: string
writingSpeedState: string
CvoAws Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CvoAws resource accepts the following input properties:
- Client
Id string - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- Region string
- The region where the working environment will be created.
- Svm
Password string - The admin password for Cloud Volumes ONTAP.
- Assume
Role stringArn - For HA only, Amazon Resource Name ARN of an AWS Identity and Access Managent IAM role that has created in the VPC owner account. For example, "arn:aws:iam::61239912384567:role/mediator_role_assume_fromdev"
- Aws
Encryption stringKms Key Arn - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- Aws
Encryption stringKms Key Id - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- List<Pulumi.
Netapp Cloudmanager. Inputs. Cvo Aws Aws Tag> - Backup
Volumes boolTo Cbs - Automatically enable back up of all volumes to S3 [true, false].
- Capacity
Package stringName - The capacity package name: ['Essential', 'Professional', 'Freemium']. Default is 'Essential'.
- Capacity
Tier string - Whether to enable data tiering for the first data aggregate: ['S3','NONE']. The default is 'S3'.
- Cloud
Provider stringAccount - The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector.
- Cluster
Floating stringIp - For HA FloatingIP, the cluster management floating IP address.
- Cluster
Key stringPair Name - Use for SSH authentication key pair method.
- Cvo
Aws stringId - The unique identifier for the working environment.
- Data
Encryption stringType - The type of encryption to use for the working environment: ['AWS', 'NONE']. The default is 'AWS'.
- Data
Floating stringIp - For HA FloatingIP, the data floating IP address.
- Data
Floating stringIp2 - Ebs
Volume doubleSize - EBS volume size for the first data aggregate. For GB, the unit can be: [100 or 500]. For TB, the unit can be: [1,2,4,8,16]. The default is '1'.
- Ebs
Volume stringSize Unit - ['GB' or 'TB']. The default is 'TB'.
- Ebs
Volume stringType - The EBS volume type for the first data aggregate ['gp3', 'gp2','io1','st1','sc1']. The default is 'gp2'.
- Enable
Compliance bool - Enable the Cloud Compliance service on the working environment [true, false].
- Enable
Monitoring bool - Enable the Monitoring service on the working environment [true, false]. The default is false.
- Failover
Mode string - For HA, the failover mode for the HA pair: ['PrivateIP', 'FloatingIP']. 'PrivateIP' is for a single availability zone and 'FloatingIP' is for multiple availability zones.
- Instance
Profile stringName - The instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile.
- Instance
Tenancy string - The EC2 instance tenancy: ['default','dedicated']. The default is 'default'.
- Instance
Type string - The instance type to use, which depends on the license type: Explore:['m5.xlarge'], Standard:['m5.2xlarge','r5.xlarge'], Premium:['m5.4xlarge','r5.2xlarge','c4.8xlarge'], BYOL: all instance types defined for PayGo. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. The default is 'm5.2xlarge'.
- Iops double
- Provisioned IOPS. Required only when 'ebs_volume_type' is 'io1' or 'gp3'.
- Is
Ha bool - Indicate whether the working environment is an HA pair or not [true, false]. The default is false.
- Kms
Key stringId - License
Type string - The type of license to use. For single node: (by Capacity): ['capacity-paygo'], (by Node paygo): ['cot-explore-paygo','cot-standard-paygo', 'cot-premium-paygo'], (by Node byol): ['cot-premium-byol']. For HA: (by Capacity): ['ha-capacity-paygo'], (by Node paygo): ['ha-cot-explore-paygo','ha-cot-standard-paygo','ha-cot-premium-paygo'], (by Node byol): 'ha-cot-premium-byol']. The default is 'capacity-paygo' for single node, and 'ha-capacity-paygo' for HA.
- Mediator
Assign boolPublic Ip - bool option to assign public IP. The default is 'true'.
- Mediator
Instance stringProfile Name - name of the mediator instance profile.
- Mediator
Key stringPair Name - For HA, the key pair name for the mediator instance.
- Mediator
Security stringGroup Id - For HA only, mediator security group id.
- Mediator
Subnet stringId - For HA, the subnet ID of the mediator.
- Name string
- The name of the Cloud Volumes ONTAP working environment.
- Node1Subnet
Id string - For HA, the subnet ID of the first node.
- Node2Subnet
Id string - For HA, the subnet ID of the second node.
- Nss
Account string - The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account isn't provided, Cloud Manager tries to use the first existing NSS account.
- Ontap
Version string The required ONTAP version. Ignored if 'use_latest_version' is set to true. The default is to use the latest version. The naming convention:
|Release|Naming convention|Example| |-------|-----------------|-------| |Patch Single |
ONTAP-${version}
| ONTAP-9.13.1P1| |Patch HA |ONTAP-${version}.ha
| ONTAP-9.13.1P1.ha| |Regular Single |ONTAP-${version}.T1
| ONTAP-9.14.0.T1| |Regular HA |ONTAP-${version}.T1.ha
| ONTAP-9.14.0.T1.ha|- Optimized
Network boolUtilization - Use optimized network utilization [true, false]. The default is true.
- Platform
Serial stringNumber - The serial number for the cluster. This is required when 'license_type' is set 'cot-premium-byol'.
- Platform
Serial stringNumber Node1 - For HA BYOL, the serial number for the first node. This is required when using 'ha-cot-premium-byol'.
- Platform
Serial stringNumber Node2 - For HA BYOL, the serial number for the second node. This is required when using 'ha-cot-premium-byol'.
- Provided
License string - Retries double
- The number of attempts to wait for the completion of creating the CVO with 60 seconds apart for each attempt. For HA, this value is incremented by 30. The default is '60'.
- Route
Table List<string>Ids - For HA FloatingIP, the list of route table IDs that will be updated with the floating IPs.
- Saas
Subscription stringId - SaaS Subscription ID. It is needed if the subscription is not paygo type.
- Security
Group stringId - The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group.
- Subnet
Id string - The subnet id where the working environment will be created. Required when single mode only.
- Svm
Floating stringIp - For HA FloatingIP, the SVM management floating IP address.
- Svm
Name string - The name of the SVM.
- Throughput double
- Required only when 'ebs_volume_type' is 'gp3'.
- Tier
Level string - The tiering level when 'capacity_tier' is set to 'S3' ['normal','ia','ia-single','intelligent']. The default is 'normal'.
- Upgrade
Ontap boolVersion - Indicates whether to upgrade ontap image with
ontap_version
. To upgrade ontap image,ontap_version
cannot be 'latest' anduse_latest_version
needs to be false. The available versions can be found in BlueXP UI. Click the CVO > click New Version Available under Notifications > the latest available version will be shown. The list of available versions can be found in Select older versions. Update theontap_version
by follow the naming conversion. - Use
Latest boolVersion - Indicates whether to use the latest available ONTAP version. The default is 'true'.
- Vpc
Id string - The VPC ID where the working environment will be created. If this argument isn't provided, the VPC will be calculated by using the provided subnet ID.
- Workspace
Id string - The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on https://console.bluexp.netapp.com/.
- Worm
Retention doublePeriod Length - WORM retention period length. Once specified retention period, the WORM is enabled. When WORM storage is activated, data tiering to object storage can’t be enabled.
- Worm
Retention stringPeriod Unit - WORM retention period unit: ['years','months','days','hours','minutes','seconds'].
- Writing
Speed stringState - The write speed setting for Cloud Volumes ONTAP: ['NORMAL','HIGH']. The default is 'NORMAL'. This argument is not relevant for HA pairs.
- Client
Id string - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- Region string
- The region where the working environment will be created.
- Svm
Password string - The admin password for Cloud Volumes ONTAP.
- Assume
Role stringArn - For HA only, Amazon Resource Name ARN of an AWS Identity and Access Managent IAM role that has created in the VPC owner account. For example, "arn:aws:iam::61239912384567:role/mediator_role_assume_fromdev"
- Aws
Encryption stringKms Key Arn - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- Aws
Encryption stringKms Key Id - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- []Cvo
Aws Aws Tag Args - Backup
Volumes boolTo Cbs - Automatically enable back up of all volumes to S3 [true, false].
- Capacity
Package stringName - The capacity package name: ['Essential', 'Professional', 'Freemium']. Default is 'Essential'.
- Capacity
Tier string - Whether to enable data tiering for the first data aggregate: ['S3','NONE']. The default is 'S3'.
- Cloud
Provider stringAccount - The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector.
- Cluster
Floating stringIp - For HA FloatingIP, the cluster management floating IP address.
- Cluster
Key stringPair Name - Use for SSH authentication key pair method.
- Cvo
Aws stringId - The unique identifier for the working environment.
- Data
Encryption stringType - The type of encryption to use for the working environment: ['AWS', 'NONE']. The default is 'AWS'.
- Data
Floating stringIp - For HA FloatingIP, the data floating IP address.
- Data
Floating stringIp2 - Ebs
Volume float64Size - EBS volume size for the first data aggregate. For GB, the unit can be: [100 or 500]. For TB, the unit can be: [1,2,4,8,16]. The default is '1'.
- Ebs
Volume stringSize Unit - ['GB' or 'TB']. The default is 'TB'.
- Ebs
Volume stringType - The EBS volume type for the first data aggregate ['gp3', 'gp2','io1','st1','sc1']. The default is 'gp2'.
- Enable
Compliance bool - Enable the Cloud Compliance service on the working environment [true, false].
- Enable
Monitoring bool - Enable the Monitoring service on the working environment [true, false]. The default is false.
- Failover
Mode string - For HA, the failover mode for the HA pair: ['PrivateIP', 'FloatingIP']. 'PrivateIP' is for a single availability zone and 'FloatingIP' is for multiple availability zones.
- Instance
Profile stringName - The instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile.
- Instance
Tenancy string - The EC2 instance tenancy: ['default','dedicated']. The default is 'default'.
- Instance
Type string - The instance type to use, which depends on the license type: Explore:['m5.xlarge'], Standard:['m5.2xlarge','r5.xlarge'], Premium:['m5.4xlarge','r5.2xlarge','c4.8xlarge'], BYOL: all instance types defined for PayGo. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. The default is 'm5.2xlarge'.
- Iops float64
- Provisioned IOPS. Required only when 'ebs_volume_type' is 'io1' or 'gp3'.
- Is
Ha bool - Indicate whether the working environment is an HA pair or not [true, false]. The default is false.
- Kms
Key stringId - License
Type string - The type of license to use. For single node: (by Capacity): ['capacity-paygo'], (by Node paygo): ['cot-explore-paygo','cot-standard-paygo', 'cot-premium-paygo'], (by Node byol): ['cot-premium-byol']. For HA: (by Capacity): ['ha-capacity-paygo'], (by Node paygo): ['ha-cot-explore-paygo','ha-cot-standard-paygo','ha-cot-premium-paygo'], (by Node byol): 'ha-cot-premium-byol']. The default is 'capacity-paygo' for single node, and 'ha-capacity-paygo' for HA.
- Mediator
Assign boolPublic Ip - bool option to assign public IP. The default is 'true'.
- Mediator
Instance stringProfile Name - name of the mediator instance profile.
- Mediator
Key stringPair Name - For HA, the key pair name for the mediator instance.
- Mediator
Security stringGroup Id - For HA only, mediator security group id.
- Mediator
Subnet stringId - For HA, the subnet ID of the mediator.
- Name string
- The name of the Cloud Volumes ONTAP working environment.
- Node1Subnet
Id string - For HA, the subnet ID of the first node.
- Node2Subnet
Id string - For HA, the subnet ID of the second node.
- Nss
Account string - The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account isn't provided, Cloud Manager tries to use the first existing NSS account.
- Ontap
Version string The required ONTAP version. Ignored if 'use_latest_version' is set to true. The default is to use the latest version. The naming convention:
|Release|Naming convention|Example| |-------|-----------------|-------| |Patch Single |
ONTAP-${version}
| ONTAP-9.13.1P1| |Patch HA |ONTAP-${version}.ha
| ONTAP-9.13.1P1.ha| |Regular Single |ONTAP-${version}.T1
| ONTAP-9.14.0.T1| |Regular HA |ONTAP-${version}.T1.ha
| ONTAP-9.14.0.T1.ha|- Optimized
Network boolUtilization - Use optimized network utilization [true, false]. The default is true.
- Platform
Serial stringNumber - The serial number for the cluster. This is required when 'license_type' is set 'cot-premium-byol'.
- Platform
Serial stringNumber Node1 - For HA BYOL, the serial number for the first node. This is required when using 'ha-cot-premium-byol'.
- Platform
Serial stringNumber Node2 - For HA BYOL, the serial number for the second node. This is required when using 'ha-cot-premium-byol'.
- Provided
License string - Retries float64
- The number of attempts to wait for the completion of creating the CVO with 60 seconds apart for each attempt. For HA, this value is incremented by 30. The default is '60'.
- Route
Table []stringIds - For HA FloatingIP, the list of route table IDs that will be updated with the floating IPs.
- Saas
Subscription stringId - SaaS Subscription ID. It is needed if the subscription is not paygo type.
- Security
Group stringId - The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group.
- Subnet
Id string - The subnet id where the working environment will be created. Required when single mode only.
- Svm
Floating stringIp - For HA FloatingIP, the SVM management floating IP address.
- Svm
Name string - The name of the SVM.
- Throughput float64
- Required only when 'ebs_volume_type' is 'gp3'.
- Tier
Level string - The tiering level when 'capacity_tier' is set to 'S3' ['normal','ia','ia-single','intelligent']. The default is 'normal'.
- Upgrade
Ontap boolVersion - Indicates whether to upgrade ontap image with
ontap_version
. To upgrade ontap image,ontap_version
cannot be 'latest' anduse_latest_version
needs to be false. The available versions can be found in BlueXP UI. Click the CVO > click New Version Available under Notifications > the latest available version will be shown. The list of available versions can be found in Select older versions. Update theontap_version
by follow the naming conversion. - Use
Latest boolVersion - Indicates whether to use the latest available ONTAP version. The default is 'true'.
- Vpc
Id string - The VPC ID where the working environment will be created. If this argument isn't provided, the VPC will be calculated by using the provided subnet ID.
- Workspace
Id string - The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on https://console.bluexp.netapp.com/.
- Worm
Retention float64Period Length - WORM retention period length. Once specified retention period, the WORM is enabled. When WORM storage is activated, data tiering to object storage can’t be enabled.
- Worm
Retention stringPeriod Unit - WORM retention period unit: ['years','months','days','hours','minutes','seconds'].
- Writing
Speed stringState - The write speed setting for Cloud Volumes ONTAP: ['NORMAL','HIGH']. The default is 'NORMAL'. This argument is not relevant for HA pairs.
- client
Id String - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- region String
- The region where the working environment will be created.
- svm
Password String - The admin password for Cloud Volumes ONTAP.
- assume
Role StringArn - For HA only, Amazon Resource Name ARN of an AWS Identity and Access Managent IAM role that has created in the VPC owner account. For example, "arn:aws:iam::61239912384567:role/mediator_role_assume_fromdev"
- aws
Encryption StringKms Key Arn - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- aws
Encryption StringKms Key Id - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- List<Cvo
Aws Aws Tag> - backup
Volumes BooleanTo Cbs - Automatically enable back up of all volumes to S3 [true, false].
- capacity
Package StringName - The capacity package name: ['Essential', 'Professional', 'Freemium']. Default is 'Essential'.
- capacity
Tier String - Whether to enable data tiering for the first data aggregate: ['S3','NONE']. The default is 'S3'.
- cloud
Provider StringAccount - The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector.
- cluster
Floating StringIp - For HA FloatingIP, the cluster management floating IP address.
- cluster
Key StringPair Name - Use for SSH authentication key pair method.
- cvo
Aws StringId - The unique identifier for the working environment.
- data
Encryption StringType - The type of encryption to use for the working environment: ['AWS', 'NONE']. The default is 'AWS'.
- data
Floating StringIp - For HA FloatingIP, the data floating IP address.
- data
Floating StringIp2 - ebs
Volume DoubleSize - EBS volume size for the first data aggregate. For GB, the unit can be: [100 or 500]. For TB, the unit can be: [1,2,4,8,16]. The default is '1'.
- ebs
Volume StringSize Unit - ['GB' or 'TB']. The default is 'TB'.
- ebs
Volume StringType - The EBS volume type for the first data aggregate ['gp3', 'gp2','io1','st1','sc1']. The default is 'gp2'.
- enable
Compliance Boolean - Enable the Cloud Compliance service on the working environment [true, false].
- enable
Monitoring Boolean - Enable the Monitoring service on the working environment [true, false]. The default is false.
- failover
Mode String - For HA, the failover mode for the HA pair: ['PrivateIP', 'FloatingIP']. 'PrivateIP' is for a single availability zone and 'FloatingIP' is for multiple availability zones.
- instance
Profile StringName - The instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile.
- instance
Tenancy String - The EC2 instance tenancy: ['default','dedicated']. The default is 'default'.
- instance
Type String - The instance type to use, which depends on the license type: Explore:['m5.xlarge'], Standard:['m5.2xlarge','r5.xlarge'], Premium:['m5.4xlarge','r5.2xlarge','c4.8xlarge'], BYOL: all instance types defined for PayGo. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. The default is 'm5.2xlarge'.
- iops Double
- Provisioned IOPS. Required only when 'ebs_volume_type' is 'io1' or 'gp3'.
- is
Ha Boolean - Indicate whether the working environment is an HA pair or not [true, false]. The default is false.
- kms
Key StringId - license
Type String - The type of license to use. For single node: (by Capacity): ['capacity-paygo'], (by Node paygo): ['cot-explore-paygo','cot-standard-paygo', 'cot-premium-paygo'], (by Node byol): ['cot-premium-byol']. For HA: (by Capacity): ['ha-capacity-paygo'], (by Node paygo): ['ha-cot-explore-paygo','ha-cot-standard-paygo','ha-cot-premium-paygo'], (by Node byol): 'ha-cot-premium-byol']. The default is 'capacity-paygo' for single node, and 'ha-capacity-paygo' for HA.
- mediator
Assign BooleanPublic Ip - bool option to assign public IP. The default is 'true'.
- mediator
Instance StringProfile Name - name of the mediator instance profile.
- mediator
Key StringPair Name - For HA, the key pair name for the mediator instance.
- mediator
Security StringGroup Id - For HA only, mediator security group id.
- mediator
Subnet StringId - For HA, the subnet ID of the mediator.
- name String
- The name of the Cloud Volumes ONTAP working environment.
- node1Subnet
Id String - For HA, the subnet ID of the first node.
- node2Subnet
Id String - For HA, the subnet ID of the second node.
- nss
Account String - The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account isn't provided, Cloud Manager tries to use the first existing NSS account.
- ontap
Version String The required ONTAP version. Ignored if 'use_latest_version' is set to true. The default is to use the latest version. The naming convention:
|Release|Naming convention|Example| |-------|-----------------|-------| |Patch Single |
ONTAP-${version}
| ONTAP-9.13.1P1| |Patch HA |ONTAP-${version}.ha
| ONTAP-9.13.1P1.ha| |Regular Single |ONTAP-${version}.T1
| ONTAP-9.14.0.T1| |Regular HA |ONTAP-${version}.T1.ha
| ONTAP-9.14.0.T1.ha|- optimized
Network BooleanUtilization - Use optimized network utilization [true, false]. The default is true.
- platform
Serial StringNumber - The serial number for the cluster. This is required when 'license_type' is set 'cot-premium-byol'.
- platform
Serial StringNumber Node1 - For HA BYOL, the serial number for the first node. This is required when using 'ha-cot-premium-byol'.
- platform
Serial StringNumber Node2 - For HA BYOL, the serial number for the second node. This is required when using 'ha-cot-premium-byol'.
- provided
License String - retries Double
- The number of attempts to wait for the completion of creating the CVO with 60 seconds apart for each attempt. For HA, this value is incremented by 30. The default is '60'.
- route
Table List<String>Ids - For HA FloatingIP, the list of route table IDs that will be updated with the floating IPs.
- saas
Subscription StringId - SaaS Subscription ID. It is needed if the subscription is not paygo type.
- security
Group StringId - The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group.
- subnet
Id String - The subnet id where the working environment will be created. Required when single mode only.
- svm
Floating StringIp - For HA FloatingIP, the SVM management floating IP address.
- svm
Name String - The name of the SVM.
- throughput Double
- Required only when 'ebs_volume_type' is 'gp3'.
- tier
Level String - The tiering level when 'capacity_tier' is set to 'S3' ['normal','ia','ia-single','intelligent']. The default is 'normal'.
- upgrade
Ontap BooleanVersion - Indicates whether to upgrade ontap image with
ontap_version
. To upgrade ontap image,ontap_version
cannot be 'latest' anduse_latest_version
needs to be false. The available versions can be found in BlueXP UI. Click the CVO > click New Version Available under Notifications > the latest available version will be shown. The list of available versions can be found in Select older versions. Update theontap_version
by follow the naming conversion. - use
Latest BooleanVersion - Indicates whether to use the latest available ONTAP version. The default is 'true'.
- vpc
Id String - The VPC ID where the working environment will be created. If this argument isn't provided, the VPC will be calculated by using the provided subnet ID.
- workspace
Id String - The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on https://console.bluexp.netapp.com/.
- worm
Retention DoublePeriod Length - WORM retention period length. Once specified retention period, the WORM is enabled. When WORM storage is activated, data tiering to object storage can’t be enabled.
- worm
Retention StringPeriod Unit - WORM retention period unit: ['years','months','days','hours','minutes','seconds'].
- writing
Speed StringState - The write speed setting for Cloud Volumes ONTAP: ['NORMAL','HIGH']. The default is 'NORMAL'. This argument is not relevant for HA pairs.
- client
Id string - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- region string
- The region where the working environment will be created.
- svm
Password string - The admin password for Cloud Volumes ONTAP.
- assume
Role stringArn - For HA only, Amazon Resource Name ARN of an AWS Identity and Access Managent IAM role that has created in the VPC owner account. For example, "arn:aws:iam::61239912384567:role/mediator_role_assume_fromdev"
- aws
Encryption stringKms Key Arn - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- aws
Encryption stringKms Key Id - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- Cvo
Aws Aws Tag[] - backup
Volumes booleanTo Cbs - Automatically enable back up of all volumes to S3 [true, false].
- capacity
Package stringName - The capacity package name: ['Essential', 'Professional', 'Freemium']. Default is 'Essential'.
- capacity
Tier string - Whether to enable data tiering for the first data aggregate: ['S3','NONE']. The default is 'S3'.
- cloud
Provider stringAccount - The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector.
- cluster
Floating stringIp - For HA FloatingIP, the cluster management floating IP address.
- cluster
Key stringPair Name - Use for SSH authentication key pair method.
- cvo
Aws stringId - The unique identifier for the working environment.
- data
Encryption stringType - The type of encryption to use for the working environment: ['AWS', 'NONE']. The default is 'AWS'.
- data
Floating stringIp - For HA FloatingIP, the data floating IP address.
- data
Floating stringIp2 - ebs
Volume numberSize - EBS volume size for the first data aggregate. For GB, the unit can be: [100 or 500]. For TB, the unit can be: [1,2,4,8,16]. The default is '1'.
- ebs
Volume stringSize Unit - ['GB' or 'TB']. The default is 'TB'.
- ebs
Volume stringType - The EBS volume type for the first data aggregate ['gp3', 'gp2','io1','st1','sc1']. The default is 'gp2'.
- enable
Compliance boolean - Enable the Cloud Compliance service on the working environment [true, false].
- enable
Monitoring boolean - Enable the Monitoring service on the working environment [true, false]. The default is false.
- failover
Mode string - For HA, the failover mode for the HA pair: ['PrivateIP', 'FloatingIP']. 'PrivateIP' is for a single availability zone and 'FloatingIP' is for multiple availability zones.
- instance
Profile stringName - The instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile.
- instance
Tenancy string - The EC2 instance tenancy: ['default','dedicated']. The default is 'default'.
- instance
Type string - The instance type to use, which depends on the license type: Explore:['m5.xlarge'], Standard:['m5.2xlarge','r5.xlarge'], Premium:['m5.4xlarge','r5.2xlarge','c4.8xlarge'], BYOL: all instance types defined for PayGo. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. The default is 'm5.2xlarge'.
- iops number
- Provisioned IOPS. Required only when 'ebs_volume_type' is 'io1' or 'gp3'.
- is
Ha boolean - Indicate whether the working environment is an HA pair or not [true, false]. The default is false.
- kms
Key stringId - license
Type string - The type of license to use. For single node: (by Capacity): ['capacity-paygo'], (by Node paygo): ['cot-explore-paygo','cot-standard-paygo', 'cot-premium-paygo'], (by Node byol): ['cot-premium-byol']. For HA: (by Capacity): ['ha-capacity-paygo'], (by Node paygo): ['ha-cot-explore-paygo','ha-cot-standard-paygo','ha-cot-premium-paygo'], (by Node byol): 'ha-cot-premium-byol']. The default is 'capacity-paygo' for single node, and 'ha-capacity-paygo' for HA.
- mediator
Assign booleanPublic Ip - bool option to assign public IP. The default is 'true'.
- mediator
Instance stringProfile Name - name of the mediator instance profile.
- mediator
Key stringPair Name - For HA, the key pair name for the mediator instance.
- mediator
Security stringGroup Id - For HA only, mediator security group id.
- mediator
Subnet stringId - For HA, the subnet ID of the mediator.
- name string
- The name of the Cloud Volumes ONTAP working environment.
- node1Subnet
Id string - For HA, the subnet ID of the first node.
- node2Subnet
Id string - For HA, the subnet ID of the second node.
- nss
Account string - The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account isn't provided, Cloud Manager tries to use the first existing NSS account.
- ontap
Version string The required ONTAP version. Ignored if 'use_latest_version' is set to true. The default is to use the latest version. The naming convention:
|Release|Naming convention|Example| |-------|-----------------|-------| |Patch Single |
ONTAP-${version}
| ONTAP-9.13.1P1| |Patch HA |ONTAP-${version}.ha
| ONTAP-9.13.1P1.ha| |Regular Single |ONTAP-${version}.T1
| ONTAP-9.14.0.T1| |Regular HA |ONTAP-${version}.T1.ha
| ONTAP-9.14.0.T1.ha|- optimized
Network booleanUtilization - Use optimized network utilization [true, false]. The default is true.
- platform
Serial stringNumber - The serial number for the cluster. This is required when 'license_type' is set 'cot-premium-byol'.
- platform
Serial stringNumber Node1 - For HA BYOL, the serial number for the first node. This is required when using 'ha-cot-premium-byol'.
- platform
Serial stringNumber Node2 - For HA BYOL, the serial number for the second node. This is required when using 'ha-cot-premium-byol'.
- provided
License string - retries number
- The number of attempts to wait for the completion of creating the CVO with 60 seconds apart for each attempt. For HA, this value is incremented by 30. The default is '60'.
- route
Table string[]Ids - For HA FloatingIP, the list of route table IDs that will be updated with the floating IPs.
- saas
Subscription stringId - SaaS Subscription ID. It is needed if the subscription is not paygo type.
- security
Group stringId - The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group.
- subnet
Id string - The subnet id where the working environment will be created. Required when single mode only.
- svm
Floating stringIp - For HA FloatingIP, the SVM management floating IP address.
- svm
Name string - The name of the SVM.
- throughput number
- Required only when 'ebs_volume_type' is 'gp3'.
- tier
Level string - The tiering level when 'capacity_tier' is set to 'S3' ['normal','ia','ia-single','intelligent']. The default is 'normal'.
- upgrade
Ontap booleanVersion - Indicates whether to upgrade ontap image with
ontap_version
. To upgrade ontap image,ontap_version
cannot be 'latest' anduse_latest_version
needs to be false. The available versions can be found in BlueXP UI. Click the CVO > click New Version Available under Notifications > the latest available version will be shown. The list of available versions can be found in Select older versions. Update theontap_version
by follow the naming conversion. - use
Latest booleanVersion - Indicates whether to use the latest available ONTAP version. The default is 'true'.
- vpc
Id string - The VPC ID where the working environment will be created. If this argument isn't provided, the VPC will be calculated by using the provided subnet ID.
- workspace
Id string - The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on https://console.bluexp.netapp.com/.
- worm
Retention numberPeriod Length - WORM retention period length. Once specified retention period, the WORM is enabled. When WORM storage is activated, data tiering to object storage can’t be enabled.
- worm
Retention stringPeriod Unit - WORM retention period unit: ['years','months','days','hours','minutes','seconds'].
- writing
Speed stringState - The write speed setting for Cloud Volumes ONTAP: ['NORMAL','HIGH']. The default is 'NORMAL'. This argument is not relevant for HA pairs.
- client_
id str - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- region str
- The region where the working environment will be created.
- svm_
password str - The admin password for Cloud Volumes ONTAP.
- assume_
role_ strarn - For HA only, Amazon Resource Name ARN of an AWS Identity and Access Managent IAM role that has created in the VPC owner account. For example, "arn:aws:iam::61239912384567:role/mediator_role_assume_fromdev"
- aws_
encryption_ strkms_ key_ arn - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- aws_
encryption_ strkms_ key_ id - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- Sequence[Cvo
Aws Aws Tag Args] - backup_
volumes_ boolto_ cbs - Automatically enable back up of all volumes to S3 [true, false].
- capacity_
package_ strname - The capacity package name: ['Essential', 'Professional', 'Freemium']. Default is 'Essential'.
- capacity_
tier str - Whether to enable data tiering for the first data aggregate: ['S3','NONE']. The default is 'S3'.
- cloud_
provider_ straccount - The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector.
- cluster_
floating_ strip - For HA FloatingIP, the cluster management floating IP address.
- cluster_
key_ strpair_ name - Use for SSH authentication key pair method.
- cvo_
aws_ strid - The unique identifier for the working environment.
- data_
encryption_ strtype - The type of encryption to use for the working environment: ['AWS', 'NONE']. The default is 'AWS'.
- data_
floating_ strip - For HA FloatingIP, the data floating IP address.
- data_
floating_ strip2 - ebs_
volume_ floatsize - EBS volume size for the first data aggregate. For GB, the unit can be: [100 or 500]. For TB, the unit can be: [1,2,4,8,16]. The default is '1'.
- ebs_
volume_ strsize_ unit - ['GB' or 'TB']. The default is 'TB'.
- ebs_
volume_ strtype - The EBS volume type for the first data aggregate ['gp3', 'gp2','io1','st1','sc1']. The default is 'gp2'.
- enable_
compliance bool - Enable the Cloud Compliance service on the working environment [true, false].
- enable_
monitoring bool - Enable the Monitoring service on the working environment [true, false]. The default is false.
- failover_
mode str - For HA, the failover mode for the HA pair: ['PrivateIP', 'FloatingIP']. 'PrivateIP' is for a single availability zone and 'FloatingIP' is for multiple availability zones.
- instance_
profile_ strname - The instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile.
- instance_
tenancy str - The EC2 instance tenancy: ['default','dedicated']. The default is 'default'.
- instance_
type str - The instance type to use, which depends on the license type: Explore:['m5.xlarge'], Standard:['m5.2xlarge','r5.xlarge'], Premium:['m5.4xlarge','r5.2xlarge','c4.8xlarge'], BYOL: all instance types defined for PayGo. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. The default is 'm5.2xlarge'.
- iops float
- Provisioned IOPS. Required only when 'ebs_volume_type' is 'io1' or 'gp3'.
- is_
ha bool - Indicate whether the working environment is an HA pair or not [true, false]. The default is false.
- kms_
key_ strid - license_
type str - The type of license to use. For single node: (by Capacity): ['capacity-paygo'], (by Node paygo): ['cot-explore-paygo','cot-standard-paygo', 'cot-premium-paygo'], (by Node byol): ['cot-premium-byol']. For HA: (by Capacity): ['ha-capacity-paygo'], (by Node paygo): ['ha-cot-explore-paygo','ha-cot-standard-paygo','ha-cot-premium-paygo'], (by Node byol): 'ha-cot-premium-byol']. The default is 'capacity-paygo' for single node, and 'ha-capacity-paygo' for HA.
- mediator_
assign_ boolpublic_ ip - bool option to assign public IP. The default is 'true'.
- mediator_
instance_ strprofile_ name - name of the mediator instance profile.
- mediator_
key_ strpair_ name - For HA, the key pair name for the mediator instance.
- mediator_
security_ strgroup_ id - For HA only, mediator security group id.
- mediator_
subnet_ strid - For HA, the subnet ID of the mediator.
- name str
- The name of the Cloud Volumes ONTAP working environment.
- node1_
subnet_ strid - For HA, the subnet ID of the first node.
- node2_
subnet_ strid - For HA, the subnet ID of the second node.
- nss_
account str - The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account isn't provided, Cloud Manager tries to use the first existing NSS account.
- ontap_
version str The required ONTAP version. Ignored if 'use_latest_version' is set to true. The default is to use the latest version. The naming convention:
|Release|Naming convention|Example| |-------|-----------------|-------| |Patch Single |
ONTAP-${version}
| ONTAP-9.13.1P1| |Patch HA |ONTAP-${version}.ha
| ONTAP-9.13.1P1.ha| |Regular Single |ONTAP-${version}.T1
| ONTAP-9.14.0.T1| |Regular HA |ONTAP-${version}.T1.ha
| ONTAP-9.14.0.T1.ha|- optimized_
network_ boolutilization - Use optimized network utilization [true, false]. The default is true.
- platform_
serial_ strnumber - The serial number for the cluster. This is required when 'license_type' is set 'cot-premium-byol'.
- platform_
serial_ strnumber_ node1 - For HA BYOL, the serial number for the first node. This is required when using 'ha-cot-premium-byol'.
- platform_
serial_ strnumber_ node2 - For HA BYOL, the serial number for the second node. This is required when using 'ha-cot-premium-byol'.
- provided_
license str - retries float
- The number of attempts to wait for the completion of creating the CVO with 60 seconds apart for each attempt. For HA, this value is incremented by 30. The default is '60'.
- route_
table_ Sequence[str]ids - For HA FloatingIP, the list of route table IDs that will be updated with the floating IPs.
- saas_
subscription_ strid - SaaS Subscription ID. It is needed if the subscription is not paygo type.
- security_
group_ strid - The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group.
- subnet_
id str - The subnet id where the working environment will be created. Required when single mode only.
- svm_
floating_ strip - For HA FloatingIP, the SVM management floating IP address.
- svm_
name str - The name of the SVM.
- throughput float
- Required only when 'ebs_volume_type' is 'gp3'.
- tier_
level str - The tiering level when 'capacity_tier' is set to 'S3' ['normal','ia','ia-single','intelligent']. The default is 'normal'.
- upgrade_
ontap_ boolversion - Indicates whether to upgrade ontap image with
ontap_version
. To upgrade ontap image,ontap_version
cannot be 'latest' anduse_latest_version
needs to be false. The available versions can be found in BlueXP UI. Click the CVO > click New Version Available under Notifications > the latest available version will be shown. The list of available versions can be found in Select older versions. Update theontap_version
by follow the naming conversion. - use_
latest_ boolversion - Indicates whether to use the latest available ONTAP version. The default is 'true'.
- vpc_
id str - The VPC ID where the working environment will be created. If this argument isn't provided, the VPC will be calculated by using the provided subnet ID.
- workspace_
id str - The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on https://console.bluexp.netapp.com/.
- worm_
retention_ floatperiod_ length - WORM retention period length. Once specified retention period, the WORM is enabled. When WORM storage is activated, data tiering to object storage can’t be enabled.
- worm_
retention_ strperiod_ unit - WORM retention period unit: ['years','months','days','hours','minutes','seconds'].
- writing_
speed_ strstate - The write speed setting for Cloud Volumes ONTAP: ['NORMAL','HIGH']. The default is 'NORMAL'. This argument is not relevant for HA pairs.
- client
Id String - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- region String
- The region where the working environment will be created.
- svm
Password String - The admin password for Cloud Volumes ONTAP.
- assume
Role StringArn - For HA only, Amazon Resource Name ARN of an AWS Identity and Access Managent IAM role that has created in the VPC owner account. For example, "arn:aws:iam::61239912384567:role/mediator_role_assume_fromdev"
- aws
Encryption StringKms Key Arn - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- aws
Encryption StringKms Key Id - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- List<Property Map>
- backup
Volumes BooleanTo Cbs - Automatically enable back up of all volumes to S3 [true, false].
- capacity
Package StringName - The capacity package name: ['Essential', 'Professional', 'Freemium']. Default is 'Essential'.
- capacity
Tier String - Whether to enable data tiering for the first data aggregate: ['S3','NONE']. The default is 'S3'.
- cloud
Provider StringAccount - The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector.
- cluster
Floating StringIp - For HA FloatingIP, the cluster management floating IP address.
- cluster
Key StringPair Name - Use for SSH authentication key pair method.
- cvo
Aws StringId - The unique identifier for the working environment.
- data
Encryption StringType - The type of encryption to use for the working environment: ['AWS', 'NONE']. The default is 'AWS'.
- data
Floating StringIp - For HA FloatingIP, the data floating IP address.
- data
Floating StringIp2 - ebs
Volume NumberSize - EBS volume size for the first data aggregate. For GB, the unit can be: [100 or 500]. For TB, the unit can be: [1,2,4,8,16]. The default is '1'.
- ebs
Volume StringSize Unit - ['GB' or 'TB']. The default is 'TB'.
- ebs
Volume StringType - The EBS volume type for the first data aggregate ['gp3', 'gp2','io1','st1','sc1']. The default is 'gp2'.
- enable
Compliance Boolean - Enable the Cloud Compliance service on the working environment [true, false].
- enable
Monitoring Boolean - Enable the Monitoring service on the working environment [true, false]. The default is false.
- failover
Mode String - For HA, the failover mode for the HA pair: ['PrivateIP', 'FloatingIP']. 'PrivateIP' is for a single availability zone and 'FloatingIP' is for multiple availability zones.
- instance
Profile StringName - The instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile.
- instance
Tenancy String - The EC2 instance tenancy: ['default','dedicated']. The default is 'default'.
- instance
Type String - The instance type to use, which depends on the license type: Explore:['m5.xlarge'], Standard:['m5.2xlarge','r5.xlarge'], Premium:['m5.4xlarge','r5.2xlarge','c4.8xlarge'], BYOL: all instance types defined for PayGo. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. The default is 'm5.2xlarge'.
- iops Number
- Provisioned IOPS. Required only when 'ebs_volume_type' is 'io1' or 'gp3'.
- is
Ha Boolean - Indicate whether the working environment is an HA pair or not [true, false]. The default is false.
- kms
Key StringId - license
Type String - The type of license to use. For single node: (by Capacity): ['capacity-paygo'], (by Node paygo): ['cot-explore-paygo','cot-standard-paygo', 'cot-premium-paygo'], (by Node byol): ['cot-premium-byol']. For HA: (by Capacity): ['ha-capacity-paygo'], (by Node paygo): ['ha-cot-explore-paygo','ha-cot-standard-paygo','ha-cot-premium-paygo'], (by Node byol): 'ha-cot-premium-byol']. The default is 'capacity-paygo' for single node, and 'ha-capacity-paygo' for HA.
- mediator
Assign BooleanPublic Ip - bool option to assign public IP. The default is 'true'.
- mediator
Instance StringProfile Name - name of the mediator instance profile.
- mediator
Key StringPair Name - For HA, the key pair name for the mediator instance.
- mediator
Security StringGroup Id - For HA only, mediator security group id.
- mediator
Subnet StringId - For HA, the subnet ID of the mediator.
- name String
- The name of the Cloud Volumes ONTAP working environment.
- node1Subnet
Id String - For HA, the subnet ID of the first node.
- node2Subnet
Id String - For HA, the subnet ID of the second node.
- nss
Account String - The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account isn't provided, Cloud Manager tries to use the first existing NSS account.
- ontap
Version String The required ONTAP version. Ignored if 'use_latest_version' is set to true. The default is to use the latest version. The naming convention:
|Release|Naming convention|Example| |-------|-----------------|-------| |Patch Single |
ONTAP-${version}
| ONTAP-9.13.1P1| |Patch HA |ONTAP-${version}.ha
| ONTAP-9.13.1P1.ha| |Regular Single |ONTAP-${version}.T1
| ONTAP-9.14.0.T1| |Regular HA |ONTAP-${version}.T1.ha
| ONTAP-9.14.0.T1.ha|- optimized
Network BooleanUtilization - Use optimized network utilization [true, false]. The default is true.
- platform
Serial StringNumber - The serial number for the cluster. This is required when 'license_type' is set 'cot-premium-byol'.
- platform
Serial StringNumber Node1 - For HA BYOL, the serial number for the first node. This is required when using 'ha-cot-premium-byol'.
- platform
Serial StringNumber Node2 - For HA BYOL, the serial number for the second node. This is required when using 'ha-cot-premium-byol'.
- provided
License String - retries Number
- The number of attempts to wait for the completion of creating the CVO with 60 seconds apart for each attempt. For HA, this value is incremented by 30. The default is '60'.
- route
Table List<String>Ids - For HA FloatingIP, the list of route table IDs that will be updated with the floating IPs.
- saas
Subscription StringId - SaaS Subscription ID. It is needed if the subscription is not paygo type.
- security
Group StringId - The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group.
- subnet
Id String - The subnet id where the working environment will be created. Required when single mode only.
- svm
Floating StringIp - For HA FloatingIP, the SVM management floating IP address.
- svm
Name String - The name of the SVM.
- throughput Number
- Required only when 'ebs_volume_type' is 'gp3'.
- tier
Level String - The tiering level when 'capacity_tier' is set to 'S3' ['normal','ia','ia-single','intelligent']. The default is 'normal'.
- upgrade
Ontap BooleanVersion - Indicates whether to upgrade ontap image with
ontap_version
. To upgrade ontap image,ontap_version
cannot be 'latest' anduse_latest_version
needs to be false. The available versions can be found in BlueXP UI. Click the CVO > click New Version Available under Notifications > the latest available version will be shown. The list of available versions can be found in Select older versions. Update theontap_version
by follow the naming conversion. - use
Latest BooleanVersion - Indicates whether to use the latest available ONTAP version. The default is 'true'.
- vpc
Id String - The VPC ID where the working environment will be created. If this argument isn't provided, the VPC will be calculated by using the provided subnet ID.
- workspace
Id String - The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on https://console.bluexp.netapp.com/.
- worm
Retention NumberPeriod Length - WORM retention period length. Once specified retention period, the WORM is enabled. When WORM storage is activated, data tiering to object storage can’t be enabled.
- worm
Retention StringPeriod Unit - WORM retention period unit: ['years','months','days','hours','minutes','seconds'].
- writing
Speed StringState - The write speed setting for Cloud Volumes ONTAP: ['NORMAL','HIGH']. The default is 'NORMAL'. This argument is not relevant for HA pairs.
Outputs
All input properties are implicitly available as output properties. Additionally, the CvoAws resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing CvoAws Resource
Get an existing CvoAws resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CvoAwsState, opts?: CustomResourceOptions): CvoAws
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
assume_role_arn: Optional[str] = None,
aws_encryption_kms_key_arn: Optional[str] = None,
aws_encryption_kms_key_id: Optional[str] = None,
aws_tags: Optional[Sequence[CvoAwsAwsTagArgs]] = None,
backup_volumes_to_cbs: Optional[bool] = None,
capacity_package_name: Optional[str] = None,
capacity_tier: Optional[str] = None,
client_id: Optional[str] = None,
cloud_provider_account: Optional[str] = None,
cluster_floating_ip: Optional[str] = None,
cluster_key_pair_name: Optional[str] = None,
cvo_aws_id: Optional[str] = None,
data_encryption_type: Optional[str] = None,
data_floating_ip: Optional[str] = None,
data_floating_ip2: Optional[str] = None,
ebs_volume_size: Optional[float] = None,
ebs_volume_size_unit: Optional[str] = None,
ebs_volume_type: Optional[str] = None,
enable_compliance: Optional[bool] = None,
enable_monitoring: Optional[bool] = None,
failover_mode: Optional[str] = None,
instance_profile_name: Optional[str] = None,
instance_tenancy: Optional[str] = None,
instance_type: Optional[str] = None,
iops: Optional[float] = None,
is_ha: Optional[bool] = None,
kms_key_id: Optional[str] = None,
license_type: Optional[str] = None,
mediator_assign_public_ip: Optional[bool] = None,
mediator_instance_profile_name: Optional[str] = None,
mediator_key_pair_name: Optional[str] = None,
mediator_security_group_id: Optional[str] = None,
mediator_subnet_id: Optional[str] = None,
name: Optional[str] = None,
node1_subnet_id: Optional[str] = None,
node2_subnet_id: Optional[str] = None,
nss_account: Optional[str] = None,
ontap_version: Optional[str] = None,
optimized_network_utilization: Optional[bool] = None,
platform_serial_number: Optional[str] = None,
platform_serial_number_node1: Optional[str] = None,
platform_serial_number_node2: Optional[str] = None,
provided_license: Optional[str] = None,
region: Optional[str] = None,
retries: Optional[float] = None,
route_table_ids: Optional[Sequence[str]] = None,
saas_subscription_id: Optional[str] = None,
security_group_id: Optional[str] = None,
subnet_id: Optional[str] = None,
svm_floating_ip: Optional[str] = None,
svm_name: Optional[str] = None,
svm_password: Optional[str] = None,
throughput: Optional[float] = None,
tier_level: Optional[str] = None,
upgrade_ontap_version: Optional[bool] = None,
use_latest_version: Optional[bool] = None,
vpc_id: Optional[str] = None,
workspace_id: Optional[str] = None,
worm_retention_period_length: Optional[float] = None,
worm_retention_period_unit: Optional[str] = None,
writing_speed_state: Optional[str] = None) -> CvoAws
func GetCvoAws(ctx *Context, name string, id IDInput, state *CvoAwsState, opts ...ResourceOption) (*CvoAws, error)
public static CvoAws Get(string name, Input<string> id, CvoAwsState? state, CustomResourceOptions? opts = null)
public static CvoAws get(String name, Output<String> id, CvoAwsState state, CustomResourceOptions options)
resources: _: type: netapp-cloudmanager:CvoAws get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Assume
Role stringArn - For HA only, Amazon Resource Name ARN of an AWS Identity and Access Managent IAM role that has created in the VPC owner account. For example, "arn:aws:iam::61239912384567:role/mediator_role_assume_fromdev"
- Aws
Encryption stringKms Key Arn - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- Aws
Encryption stringKms Key Id - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- List<Pulumi.
Netapp Cloudmanager. Inputs. Cvo Aws Aws Tag> - Backup
Volumes boolTo Cbs - Automatically enable back up of all volumes to S3 [true, false].
- Capacity
Package stringName - The capacity package name: ['Essential', 'Professional', 'Freemium']. Default is 'Essential'.
- Capacity
Tier string - Whether to enable data tiering for the first data aggregate: ['S3','NONE']. The default is 'S3'.
- Client
Id string - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- Cloud
Provider stringAccount - The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector.
- Cluster
Floating stringIp - For HA FloatingIP, the cluster management floating IP address.
- Cluster
Key stringPair Name - Use for SSH authentication key pair method.
- Cvo
Aws stringId - The unique identifier for the working environment.
- Data
Encryption stringType - The type of encryption to use for the working environment: ['AWS', 'NONE']. The default is 'AWS'.
- Data
Floating stringIp - For HA FloatingIP, the data floating IP address.
- Data
Floating stringIp2 - Ebs
Volume doubleSize - EBS volume size for the first data aggregate. For GB, the unit can be: [100 or 500]. For TB, the unit can be: [1,2,4,8,16]. The default is '1'.
- Ebs
Volume stringSize Unit - ['GB' or 'TB']. The default is 'TB'.
- Ebs
Volume stringType - The EBS volume type for the first data aggregate ['gp3', 'gp2','io1','st1','sc1']. The default is 'gp2'.
- Enable
Compliance bool - Enable the Cloud Compliance service on the working environment [true, false].
- Enable
Monitoring bool - Enable the Monitoring service on the working environment [true, false]. The default is false.
- Failover
Mode string - For HA, the failover mode for the HA pair: ['PrivateIP', 'FloatingIP']. 'PrivateIP' is for a single availability zone and 'FloatingIP' is for multiple availability zones.
- Instance
Profile stringName - The instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile.
- Instance
Tenancy string - The EC2 instance tenancy: ['default','dedicated']. The default is 'default'.
- Instance
Type string - The instance type to use, which depends on the license type: Explore:['m5.xlarge'], Standard:['m5.2xlarge','r5.xlarge'], Premium:['m5.4xlarge','r5.2xlarge','c4.8xlarge'], BYOL: all instance types defined for PayGo. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. The default is 'm5.2xlarge'.
- Iops double
- Provisioned IOPS. Required only when 'ebs_volume_type' is 'io1' or 'gp3'.
- Is
Ha bool - Indicate whether the working environment is an HA pair or not [true, false]. The default is false.
- Kms
Key stringId - License
Type string - The type of license to use. For single node: (by Capacity): ['capacity-paygo'], (by Node paygo): ['cot-explore-paygo','cot-standard-paygo', 'cot-premium-paygo'], (by Node byol): ['cot-premium-byol']. For HA: (by Capacity): ['ha-capacity-paygo'], (by Node paygo): ['ha-cot-explore-paygo','ha-cot-standard-paygo','ha-cot-premium-paygo'], (by Node byol): 'ha-cot-premium-byol']. The default is 'capacity-paygo' for single node, and 'ha-capacity-paygo' for HA.
- Mediator
Assign boolPublic Ip - bool option to assign public IP. The default is 'true'.
- Mediator
Instance stringProfile Name - name of the mediator instance profile.
- Mediator
Key stringPair Name - For HA, the key pair name for the mediator instance.
- Mediator
Security stringGroup Id - For HA only, mediator security group id.
- Mediator
Subnet stringId - For HA, the subnet ID of the mediator.
- Name string
- The name of the Cloud Volumes ONTAP working environment.
- Node1Subnet
Id string - For HA, the subnet ID of the first node.
- Node2Subnet
Id string - For HA, the subnet ID of the second node.
- Nss
Account string - The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account isn't provided, Cloud Manager tries to use the first existing NSS account.
- Ontap
Version string The required ONTAP version. Ignored if 'use_latest_version' is set to true. The default is to use the latest version. The naming convention:
|Release|Naming convention|Example| |-------|-----------------|-------| |Patch Single |
ONTAP-${version}
| ONTAP-9.13.1P1| |Patch HA |ONTAP-${version}.ha
| ONTAP-9.13.1P1.ha| |Regular Single |ONTAP-${version}.T1
| ONTAP-9.14.0.T1| |Regular HA |ONTAP-${version}.T1.ha
| ONTAP-9.14.0.T1.ha|- Optimized
Network boolUtilization - Use optimized network utilization [true, false]. The default is true.
- Platform
Serial stringNumber - The serial number for the cluster. This is required when 'license_type' is set 'cot-premium-byol'.
- Platform
Serial stringNumber Node1 - For HA BYOL, the serial number for the first node. This is required when using 'ha-cot-premium-byol'.
- Platform
Serial stringNumber Node2 - For HA BYOL, the serial number for the second node. This is required when using 'ha-cot-premium-byol'.
- Provided
License string - Region string
- The region where the working environment will be created.
- Retries double
- The number of attempts to wait for the completion of creating the CVO with 60 seconds apart for each attempt. For HA, this value is incremented by 30. The default is '60'.
- Route
Table List<string>Ids - For HA FloatingIP, the list of route table IDs that will be updated with the floating IPs.
- Saas
Subscription stringId - SaaS Subscription ID. It is needed if the subscription is not paygo type.
- Security
Group stringId - The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group.
- Subnet
Id string - The subnet id where the working environment will be created. Required when single mode only.
- Svm
Floating stringIp - For HA FloatingIP, the SVM management floating IP address.
- Svm
Name string - The name of the SVM.
- Svm
Password string - The admin password for Cloud Volumes ONTAP.
- Throughput double
- Required only when 'ebs_volume_type' is 'gp3'.
- Tier
Level string - The tiering level when 'capacity_tier' is set to 'S3' ['normal','ia','ia-single','intelligent']. The default is 'normal'.
- Upgrade
Ontap boolVersion - Indicates whether to upgrade ontap image with
ontap_version
. To upgrade ontap image,ontap_version
cannot be 'latest' anduse_latest_version
needs to be false. The available versions can be found in BlueXP UI. Click the CVO > click New Version Available under Notifications > the latest available version will be shown. The list of available versions can be found in Select older versions. Update theontap_version
by follow the naming conversion. - Use
Latest boolVersion - Indicates whether to use the latest available ONTAP version. The default is 'true'.
- Vpc
Id string - The VPC ID where the working environment will be created. If this argument isn't provided, the VPC will be calculated by using the provided subnet ID.
- Workspace
Id string - The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on https://console.bluexp.netapp.com/.
- Worm
Retention doublePeriod Length - WORM retention period length. Once specified retention period, the WORM is enabled. When WORM storage is activated, data tiering to object storage can’t be enabled.
- Worm
Retention stringPeriod Unit - WORM retention period unit: ['years','months','days','hours','minutes','seconds'].
- Writing
Speed stringState - The write speed setting for Cloud Volumes ONTAP: ['NORMAL','HIGH']. The default is 'NORMAL'. This argument is not relevant for HA pairs.
- Assume
Role stringArn - For HA only, Amazon Resource Name ARN of an AWS Identity and Access Managent IAM role that has created in the VPC owner account. For example, "arn:aws:iam::61239912384567:role/mediator_role_assume_fromdev"
- Aws
Encryption stringKms Key Arn - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- Aws
Encryption stringKms Key Id - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- []Cvo
Aws Aws Tag Args - Backup
Volumes boolTo Cbs - Automatically enable back up of all volumes to S3 [true, false].
- Capacity
Package stringName - The capacity package name: ['Essential', 'Professional', 'Freemium']. Default is 'Essential'.
- Capacity
Tier string - Whether to enable data tiering for the first data aggregate: ['S3','NONE']. The default is 'S3'.
- Client
Id string - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- Cloud
Provider stringAccount - The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector.
- Cluster
Floating stringIp - For HA FloatingIP, the cluster management floating IP address.
- Cluster
Key stringPair Name - Use for SSH authentication key pair method.
- Cvo
Aws stringId - The unique identifier for the working environment.
- Data
Encryption stringType - The type of encryption to use for the working environment: ['AWS', 'NONE']. The default is 'AWS'.
- Data
Floating stringIp - For HA FloatingIP, the data floating IP address.
- Data
Floating stringIp2 - Ebs
Volume float64Size - EBS volume size for the first data aggregate. For GB, the unit can be: [100 or 500]. For TB, the unit can be: [1,2,4,8,16]. The default is '1'.
- Ebs
Volume stringSize Unit - ['GB' or 'TB']. The default is 'TB'.
- Ebs
Volume stringType - The EBS volume type for the first data aggregate ['gp3', 'gp2','io1','st1','sc1']. The default is 'gp2'.
- Enable
Compliance bool - Enable the Cloud Compliance service on the working environment [true, false].
- Enable
Monitoring bool - Enable the Monitoring service on the working environment [true, false]. The default is false.
- Failover
Mode string - For HA, the failover mode for the HA pair: ['PrivateIP', 'FloatingIP']. 'PrivateIP' is for a single availability zone and 'FloatingIP' is for multiple availability zones.
- Instance
Profile stringName - The instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile.
- Instance
Tenancy string - The EC2 instance tenancy: ['default','dedicated']. The default is 'default'.
- Instance
Type string - The instance type to use, which depends on the license type: Explore:['m5.xlarge'], Standard:['m5.2xlarge','r5.xlarge'], Premium:['m5.4xlarge','r5.2xlarge','c4.8xlarge'], BYOL: all instance types defined for PayGo. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. The default is 'm5.2xlarge'.
- Iops float64
- Provisioned IOPS. Required only when 'ebs_volume_type' is 'io1' or 'gp3'.
- Is
Ha bool - Indicate whether the working environment is an HA pair or not [true, false]. The default is false.
- Kms
Key stringId - License
Type string - The type of license to use. For single node: (by Capacity): ['capacity-paygo'], (by Node paygo): ['cot-explore-paygo','cot-standard-paygo', 'cot-premium-paygo'], (by Node byol): ['cot-premium-byol']. For HA: (by Capacity): ['ha-capacity-paygo'], (by Node paygo): ['ha-cot-explore-paygo','ha-cot-standard-paygo','ha-cot-premium-paygo'], (by Node byol): 'ha-cot-premium-byol']. The default is 'capacity-paygo' for single node, and 'ha-capacity-paygo' for HA.
- Mediator
Assign boolPublic Ip - bool option to assign public IP. The default is 'true'.
- Mediator
Instance stringProfile Name - name of the mediator instance profile.
- Mediator
Key stringPair Name - For HA, the key pair name for the mediator instance.
- Mediator
Security stringGroup Id - For HA only, mediator security group id.
- Mediator
Subnet stringId - For HA, the subnet ID of the mediator.
- Name string
- The name of the Cloud Volumes ONTAP working environment.
- Node1Subnet
Id string - For HA, the subnet ID of the first node.
- Node2Subnet
Id string - For HA, the subnet ID of the second node.
- Nss
Account string - The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account isn't provided, Cloud Manager tries to use the first existing NSS account.
- Ontap
Version string The required ONTAP version. Ignored if 'use_latest_version' is set to true. The default is to use the latest version. The naming convention:
|Release|Naming convention|Example| |-------|-----------------|-------| |Patch Single |
ONTAP-${version}
| ONTAP-9.13.1P1| |Patch HA |ONTAP-${version}.ha
| ONTAP-9.13.1P1.ha| |Regular Single |ONTAP-${version}.T1
| ONTAP-9.14.0.T1| |Regular HA |ONTAP-${version}.T1.ha
| ONTAP-9.14.0.T1.ha|- Optimized
Network boolUtilization - Use optimized network utilization [true, false]. The default is true.
- Platform
Serial stringNumber - The serial number for the cluster. This is required when 'license_type' is set 'cot-premium-byol'.
- Platform
Serial stringNumber Node1 - For HA BYOL, the serial number for the first node. This is required when using 'ha-cot-premium-byol'.
- Platform
Serial stringNumber Node2 - For HA BYOL, the serial number for the second node. This is required when using 'ha-cot-premium-byol'.
- Provided
License string - Region string
- The region where the working environment will be created.
- Retries float64
- The number of attempts to wait for the completion of creating the CVO with 60 seconds apart for each attempt. For HA, this value is incremented by 30. The default is '60'.
- Route
Table []stringIds - For HA FloatingIP, the list of route table IDs that will be updated with the floating IPs.
- Saas
Subscription stringId - SaaS Subscription ID. It is needed if the subscription is not paygo type.
- Security
Group stringId - The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group.
- Subnet
Id string - The subnet id where the working environment will be created. Required when single mode only.
- Svm
Floating stringIp - For HA FloatingIP, the SVM management floating IP address.
- Svm
Name string - The name of the SVM.
- Svm
Password string - The admin password for Cloud Volumes ONTAP.
- Throughput float64
- Required only when 'ebs_volume_type' is 'gp3'.
- Tier
Level string - The tiering level when 'capacity_tier' is set to 'S3' ['normal','ia','ia-single','intelligent']. The default is 'normal'.
- Upgrade
Ontap boolVersion - Indicates whether to upgrade ontap image with
ontap_version
. To upgrade ontap image,ontap_version
cannot be 'latest' anduse_latest_version
needs to be false. The available versions can be found in BlueXP UI. Click the CVO > click New Version Available under Notifications > the latest available version will be shown. The list of available versions can be found in Select older versions. Update theontap_version
by follow the naming conversion. - Use
Latest boolVersion - Indicates whether to use the latest available ONTAP version. The default is 'true'.
- Vpc
Id string - The VPC ID where the working environment will be created. If this argument isn't provided, the VPC will be calculated by using the provided subnet ID.
- Workspace
Id string - The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on https://console.bluexp.netapp.com/.
- Worm
Retention float64Period Length - WORM retention period length. Once specified retention period, the WORM is enabled. When WORM storage is activated, data tiering to object storage can’t be enabled.
- Worm
Retention stringPeriod Unit - WORM retention period unit: ['years','months','days','hours','minutes','seconds'].
- Writing
Speed stringState - The write speed setting for Cloud Volumes ONTAP: ['NORMAL','HIGH']. The default is 'NORMAL'. This argument is not relevant for HA pairs.
- assume
Role StringArn - For HA only, Amazon Resource Name ARN of an AWS Identity and Access Managent IAM role that has created in the VPC owner account. For example, "arn:aws:iam::61239912384567:role/mediator_role_assume_fromdev"
- aws
Encryption StringKms Key Arn - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- aws
Encryption StringKms Key Id - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- List<Cvo
Aws Aws Tag> - backup
Volumes BooleanTo Cbs - Automatically enable back up of all volumes to S3 [true, false].
- capacity
Package StringName - The capacity package name: ['Essential', 'Professional', 'Freemium']. Default is 'Essential'.
- capacity
Tier String - Whether to enable data tiering for the first data aggregate: ['S3','NONE']. The default is 'S3'.
- client
Id String - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- cloud
Provider StringAccount - The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector.
- cluster
Floating StringIp - For HA FloatingIP, the cluster management floating IP address.
- cluster
Key StringPair Name - Use for SSH authentication key pair method.
- cvo
Aws StringId - The unique identifier for the working environment.
- data
Encryption StringType - The type of encryption to use for the working environment: ['AWS', 'NONE']. The default is 'AWS'.
- data
Floating StringIp - For HA FloatingIP, the data floating IP address.
- data
Floating StringIp2 - ebs
Volume DoubleSize - EBS volume size for the first data aggregate. For GB, the unit can be: [100 or 500]. For TB, the unit can be: [1,2,4,8,16]. The default is '1'.
- ebs
Volume StringSize Unit - ['GB' or 'TB']. The default is 'TB'.
- ebs
Volume StringType - The EBS volume type for the first data aggregate ['gp3', 'gp2','io1','st1','sc1']. The default is 'gp2'.
- enable
Compliance Boolean - Enable the Cloud Compliance service on the working environment [true, false].
- enable
Monitoring Boolean - Enable the Monitoring service on the working environment [true, false]. The default is false.
- failover
Mode String - For HA, the failover mode for the HA pair: ['PrivateIP', 'FloatingIP']. 'PrivateIP' is for a single availability zone and 'FloatingIP' is for multiple availability zones.
- instance
Profile StringName - The instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile.
- instance
Tenancy String - The EC2 instance tenancy: ['default','dedicated']. The default is 'default'.
- instance
Type String - The instance type to use, which depends on the license type: Explore:['m5.xlarge'], Standard:['m5.2xlarge','r5.xlarge'], Premium:['m5.4xlarge','r5.2xlarge','c4.8xlarge'], BYOL: all instance types defined for PayGo. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. The default is 'm5.2xlarge'.
- iops Double
- Provisioned IOPS. Required only when 'ebs_volume_type' is 'io1' or 'gp3'.
- is
Ha Boolean - Indicate whether the working environment is an HA pair or not [true, false]. The default is false.
- kms
Key StringId - license
Type String - The type of license to use. For single node: (by Capacity): ['capacity-paygo'], (by Node paygo): ['cot-explore-paygo','cot-standard-paygo', 'cot-premium-paygo'], (by Node byol): ['cot-premium-byol']. For HA: (by Capacity): ['ha-capacity-paygo'], (by Node paygo): ['ha-cot-explore-paygo','ha-cot-standard-paygo','ha-cot-premium-paygo'], (by Node byol): 'ha-cot-premium-byol']. The default is 'capacity-paygo' for single node, and 'ha-capacity-paygo' for HA.
- mediator
Assign BooleanPublic Ip - bool option to assign public IP. The default is 'true'.
- mediator
Instance StringProfile Name - name of the mediator instance profile.
- mediator
Key StringPair Name - For HA, the key pair name for the mediator instance.
- mediator
Security StringGroup Id - For HA only, mediator security group id.
- mediator
Subnet StringId - For HA, the subnet ID of the mediator.
- name String
- The name of the Cloud Volumes ONTAP working environment.
- node1Subnet
Id String - For HA, the subnet ID of the first node.
- node2Subnet
Id String - For HA, the subnet ID of the second node.
- nss
Account String - The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account isn't provided, Cloud Manager tries to use the first existing NSS account.
- ontap
Version String The required ONTAP version. Ignored if 'use_latest_version' is set to true. The default is to use the latest version. The naming convention:
|Release|Naming convention|Example| |-------|-----------------|-------| |Patch Single |
ONTAP-${version}
| ONTAP-9.13.1P1| |Patch HA |ONTAP-${version}.ha
| ONTAP-9.13.1P1.ha| |Regular Single |ONTAP-${version}.T1
| ONTAP-9.14.0.T1| |Regular HA |ONTAP-${version}.T1.ha
| ONTAP-9.14.0.T1.ha|- optimized
Network BooleanUtilization - Use optimized network utilization [true, false]. The default is true.
- platform
Serial StringNumber - The serial number for the cluster. This is required when 'license_type' is set 'cot-premium-byol'.
- platform
Serial StringNumber Node1 - For HA BYOL, the serial number for the first node. This is required when using 'ha-cot-premium-byol'.
- platform
Serial StringNumber Node2 - For HA BYOL, the serial number for the second node. This is required when using 'ha-cot-premium-byol'.
- provided
License String - region String
- The region where the working environment will be created.
- retries Double
- The number of attempts to wait for the completion of creating the CVO with 60 seconds apart for each attempt. For HA, this value is incremented by 30. The default is '60'.
- route
Table List<String>Ids - For HA FloatingIP, the list of route table IDs that will be updated with the floating IPs.
- saas
Subscription StringId - SaaS Subscription ID. It is needed if the subscription is not paygo type.
- security
Group StringId - The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group.
- subnet
Id String - The subnet id where the working environment will be created. Required when single mode only.
- svm
Floating StringIp - For HA FloatingIP, the SVM management floating IP address.
- svm
Name String - The name of the SVM.
- svm
Password String - The admin password for Cloud Volumes ONTAP.
- throughput Double
- Required only when 'ebs_volume_type' is 'gp3'.
- tier
Level String - The tiering level when 'capacity_tier' is set to 'S3' ['normal','ia','ia-single','intelligent']. The default is 'normal'.
- upgrade
Ontap BooleanVersion - Indicates whether to upgrade ontap image with
ontap_version
. To upgrade ontap image,ontap_version
cannot be 'latest' anduse_latest_version
needs to be false. The available versions can be found in BlueXP UI. Click the CVO > click New Version Available under Notifications > the latest available version will be shown. The list of available versions can be found in Select older versions. Update theontap_version
by follow the naming conversion. - use
Latest BooleanVersion - Indicates whether to use the latest available ONTAP version. The default is 'true'.
- vpc
Id String - The VPC ID where the working environment will be created. If this argument isn't provided, the VPC will be calculated by using the provided subnet ID.
- workspace
Id String - The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on https://console.bluexp.netapp.com/.
- worm
Retention DoublePeriod Length - WORM retention period length. Once specified retention period, the WORM is enabled. When WORM storage is activated, data tiering to object storage can’t be enabled.
- worm
Retention StringPeriod Unit - WORM retention period unit: ['years','months','days','hours','minutes','seconds'].
- writing
Speed StringState - The write speed setting for Cloud Volumes ONTAP: ['NORMAL','HIGH']. The default is 'NORMAL'. This argument is not relevant for HA pairs.
- assume
Role stringArn - For HA only, Amazon Resource Name ARN of an AWS Identity and Access Managent IAM role that has created in the VPC owner account. For example, "arn:aws:iam::61239912384567:role/mediator_role_assume_fromdev"
- aws
Encryption stringKms Key Arn - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- aws
Encryption stringKms Key Id - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- Cvo
Aws Aws Tag[] - backup
Volumes booleanTo Cbs - Automatically enable back up of all volumes to S3 [true, false].
- capacity
Package stringName - The capacity package name: ['Essential', 'Professional', 'Freemium']. Default is 'Essential'.
- capacity
Tier string - Whether to enable data tiering for the first data aggregate: ['S3','NONE']. The default is 'S3'.
- client
Id string - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- cloud
Provider stringAccount - The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector.
- cluster
Floating stringIp - For HA FloatingIP, the cluster management floating IP address.
- cluster
Key stringPair Name - Use for SSH authentication key pair method.
- cvo
Aws stringId - The unique identifier for the working environment.
- data
Encryption stringType - The type of encryption to use for the working environment: ['AWS', 'NONE']. The default is 'AWS'.
- data
Floating stringIp - For HA FloatingIP, the data floating IP address.
- data
Floating stringIp2 - ebs
Volume numberSize - EBS volume size for the first data aggregate. For GB, the unit can be: [100 or 500]. For TB, the unit can be: [1,2,4,8,16]. The default is '1'.
- ebs
Volume stringSize Unit - ['GB' or 'TB']. The default is 'TB'.
- ebs
Volume stringType - The EBS volume type for the first data aggregate ['gp3', 'gp2','io1','st1','sc1']. The default is 'gp2'.
- enable
Compliance boolean - Enable the Cloud Compliance service on the working environment [true, false].
- enable
Monitoring boolean - Enable the Monitoring service on the working environment [true, false]. The default is false.
- failover
Mode string - For HA, the failover mode for the HA pair: ['PrivateIP', 'FloatingIP']. 'PrivateIP' is for a single availability zone and 'FloatingIP' is for multiple availability zones.
- instance
Profile stringName - The instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile.
- instance
Tenancy string - The EC2 instance tenancy: ['default','dedicated']. The default is 'default'.
- instance
Type string - The instance type to use, which depends on the license type: Explore:['m5.xlarge'], Standard:['m5.2xlarge','r5.xlarge'], Premium:['m5.4xlarge','r5.2xlarge','c4.8xlarge'], BYOL: all instance types defined for PayGo. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. The default is 'm5.2xlarge'.
- iops number
- Provisioned IOPS. Required only when 'ebs_volume_type' is 'io1' or 'gp3'.
- is
Ha boolean - Indicate whether the working environment is an HA pair or not [true, false]. The default is false.
- kms
Key stringId - license
Type string - The type of license to use. For single node: (by Capacity): ['capacity-paygo'], (by Node paygo): ['cot-explore-paygo','cot-standard-paygo', 'cot-premium-paygo'], (by Node byol): ['cot-premium-byol']. For HA: (by Capacity): ['ha-capacity-paygo'], (by Node paygo): ['ha-cot-explore-paygo','ha-cot-standard-paygo','ha-cot-premium-paygo'], (by Node byol): 'ha-cot-premium-byol']. The default is 'capacity-paygo' for single node, and 'ha-capacity-paygo' for HA.
- mediator
Assign booleanPublic Ip - bool option to assign public IP. The default is 'true'.
- mediator
Instance stringProfile Name - name of the mediator instance profile.
- mediator
Key stringPair Name - For HA, the key pair name for the mediator instance.
- mediator
Security stringGroup Id - For HA only, mediator security group id.
- mediator
Subnet stringId - For HA, the subnet ID of the mediator.
- name string
- The name of the Cloud Volumes ONTAP working environment.
- node1Subnet
Id string - For HA, the subnet ID of the first node.
- node2Subnet
Id string - For HA, the subnet ID of the second node.
- nss
Account string - The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account isn't provided, Cloud Manager tries to use the first existing NSS account.
- ontap
Version string The required ONTAP version. Ignored if 'use_latest_version' is set to true. The default is to use the latest version. The naming convention:
|Release|Naming convention|Example| |-------|-----------------|-------| |Patch Single |
ONTAP-${version}
| ONTAP-9.13.1P1| |Patch HA |ONTAP-${version}.ha
| ONTAP-9.13.1P1.ha| |Regular Single |ONTAP-${version}.T1
| ONTAP-9.14.0.T1| |Regular HA |ONTAP-${version}.T1.ha
| ONTAP-9.14.0.T1.ha|- optimized
Network booleanUtilization - Use optimized network utilization [true, false]. The default is true.
- platform
Serial stringNumber - The serial number for the cluster. This is required when 'license_type' is set 'cot-premium-byol'.
- platform
Serial stringNumber Node1 - For HA BYOL, the serial number for the first node. This is required when using 'ha-cot-premium-byol'.
- platform
Serial stringNumber Node2 - For HA BYOL, the serial number for the second node. This is required when using 'ha-cot-premium-byol'.
- provided
License string - region string
- The region where the working environment will be created.
- retries number
- The number of attempts to wait for the completion of creating the CVO with 60 seconds apart for each attempt. For HA, this value is incremented by 30. The default is '60'.
- route
Table string[]Ids - For HA FloatingIP, the list of route table IDs that will be updated with the floating IPs.
- saas
Subscription stringId - SaaS Subscription ID. It is needed if the subscription is not paygo type.
- security
Group stringId - The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group.
- subnet
Id string - The subnet id where the working environment will be created. Required when single mode only.
- svm
Floating stringIp - For HA FloatingIP, the SVM management floating IP address.
- svm
Name string - The name of the SVM.
- svm
Password string - The admin password for Cloud Volumes ONTAP.
- throughput number
- Required only when 'ebs_volume_type' is 'gp3'.
- tier
Level string - The tiering level when 'capacity_tier' is set to 'S3' ['normal','ia','ia-single','intelligent']. The default is 'normal'.
- upgrade
Ontap booleanVersion - Indicates whether to upgrade ontap image with
ontap_version
. To upgrade ontap image,ontap_version
cannot be 'latest' anduse_latest_version
needs to be false. The available versions can be found in BlueXP UI. Click the CVO > click New Version Available under Notifications > the latest available version will be shown. The list of available versions can be found in Select older versions. Update theontap_version
by follow the naming conversion. - use
Latest booleanVersion - Indicates whether to use the latest available ONTAP version. The default is 'true'.
- vpc
Id string - The VPC ID where the working environment will be created. If this argument isn't provided, the VPC will be calculated by using the provided subnet ID.
- workspace
Id string - The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on https://console.bluexp.netapp.com/.
- worm
Retention numberPeriod Length - WORM retention period length. Once specified retention period, the WORM is enabled. When WORM storage is activated, data tiering to object storage can’t be enabled.
- worm
Retention stringPeriod Unit - WORM retention period unit: ['years','months','days','hours','minutes','seconds'].
- writing
Speed stringState - The write speed setting for Cloud Volumes ONTAP: ['NORMAL','HIGH']. The default is 'NORMAL'. This argument is not relevant for HA pairs.
- assume_
role_ strarn - For HA only, Amazon Resource Name ARN of an AWS Identity and Access Managent IAM role that has created in the VPC owner account. For example, "arn:aws:iam::61239912384567:role/mediator_role_assume_fromdev"
- aws_
encryption_ strkms_ key_ arn - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- aws_
encryption_ strkms_ key_ id - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- Sequence[Cvo
Aws Aws Tag Args] - backup_
volumes_ boolto_ cbs - Automatically enable back up of all volumes to S3 [true, false].
- capacity_
package_ strname - The capacity package name: ['Essential', 'Professional', 'Freemium']. Default is 'Essential'.
- capacity_
tier str - Whether to enable data tiering for the first data aggregate: ['S3','NONE']. The default is 'S3'.
- client_
id str - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- cloud_
provider_ straccount - The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector.
- cluster_
floating_ strip - For HA FloatingIP, the cluster management floating IP address.
- cluster_
key_ strpair_ name - Use for SSH authentication key pair method.
- cvo_
aws_ strid - The unique identifier for the working environment.
- data_
encryption_ strtype - The type of encryption to use for the working environment: ['AWS', 'NONE']. The default is 'AWS'.
- data_
floating_ strip - For HA FloatingIP, the data floating IP address.
- data_
floating_ strip2 - ebs_
volume_ floatsize - EBS volume size for the first data aggregate. For GB, the unit can be: [100 or 500]. For TB, the unit can be: [1,2,4,8,16]. The default is '1'.
- ebs_
volume_ strsize_ unit - ['GB' or 'TB']. The default is 'TB'.
- ebs_
volume_ strtype - The EBS volume type for the first data aggregate ['gp3', 'gp2','io1','st1','sc1']. The default is 'gp2'.
- enable_
compliance bool - Enable the Cloud Compliance service on the working environment [true, false].
- enable_
monitoring bool - Enable the Monitoring service on the working environment [true, false]. The default is false.
- failover_
mode str - For HA, the failover mode for the HA pair: ['PrivateIP', 'FloatingIP']. 'PrivateIP' is for a single availability zone and 'FloatingIP' is for multiple availability zones.
- instance_
profile_ strname - The instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile.
- instance_
tenancy str - The EC2 instance tenancy: ['default','dedicated']. The default is 'default'.
- instance_
type str - The instance type to use, which depends on the license type: Explore:['m5.xlarge'], Standard:['m5.2xlarge','r5.xlarge'], Premium:['m5.4xlarge','r5.2xlarge','c4.8xlarge'], BYOL: all instance types defined for PayGo. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. The default is 'm5.2xlarge'.
- iops float
- Provisioned IOPS. Required only when 'ebs_volume_type' is 'io1' or 'gp3'.
- is_
ha bool - Indicate whether the working environment is an HA pair or not [true, false]. The default is false.
- kms_
key_ strid - license_
type str - The type of license to use. For single node: (by Capacity): ['capacity-paygo'], (by Node paygo): ['cot-explore-paygo','cot-standard-paygo', 'cot-premium-paygo'], (by Node byol): ['cot-premium-byol']. For HA: (by Capacity): ['ha-capacity-paygo'], (by Node paygo): ['ha-cot-explore-paygo','ha-cot-standard-paygo','ha-cot-premium-paygo'], (by Node byol): 'ha-cot-premium-byol']. The default is 'capacity-paygo' for single node, and 'ha-capacity-paygo' for HA.
- mediator_
assign_ boolpublic_ ip - bool option to assign public IP. The default is 'true'.
- mediator_
instance_ strprofile_ name - name of the mediator instance profile.
- mediator_
key_ strpair_ name - For HA, the key pair name for the mediator instance.
- mediator_
security_ strgroup_ id - For HA only, mediator security group id.
- mediator_
subnet_ strid - For HA, the subnet ID of the mediator.
- name str
- The name of the Cloud Volumes ONTAP working environment.
- node1_
subnet_ strid - For HA, the subnet ID of the first node.
- node2_
subnet_ strid - For HA, the subnet ID of the second node.
- nss_
account str - The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account isn't provided, Cloud Manager tries to use the first existing NSS account.
- ontap_
version str The required ONTAP version. Ignored if 'use_latest_version' is set to true. The default is to use the latest version. The naming convention:
|Release|Naming convention|Example| |-------|-----------------|-------| |Patch Single |
ONTAP-${version}
| ONTAP-9.13.1P1| |Patch HA |ONTAP-${version}.ha
| ONTAP-9.13.1P1.ha| |Regular Single |ONTAP-${version}.T1
| ONTAP-9.14.0.T1| |Regular HA |ONTAP-${version}.T1.ha
| ONTAP-9.14.0.T1.ha|- optimized_
network_ boolutilization - Use optimized network utilization [true, false]. The default is true.
- platform_
serial_ strnumber - The serial number for the cluster. This is required when 'license_type' is set 'cot-premium-byol'.
- platform_
serial_ strnumber_ node1 - For HA BYOL, the serial number for the first node. This is required when using 'ha-cot-premium-byol'.
- platform_
serial_ strnumber_ node2 - For HA BYOL, the serial number for the second node. This is required when using 'ha-cot-premium-byol'.
- provided_
license str - region str
- The region where the working environment will be created.
- retries float
- The number of attempts to wait for the completion of creating the CVO with 60 seconds apart for each attempt. For HA, this value is incremented by 30. The default is '60'.
- route_
table_ Sequence[str]ids - For HA FloatingIP, the list of route table IDs that will be updated with the floating IPs.
- saas_
subscription_ strid - SaaS Subscription ID. It is needed if the subscription is not paygo type.
- security_
group_ strid - The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group.
- subnet_
id str - The subnet id where the working environment will be created. Required when single mode only.
- svm_
floating_ strip - For HA FloatingIP, the SVM management floating IP address.
- svm_
name str - The name of the SVM.
- svm_
password str - The admin password for Cloud Volumes ONTAP.
- throughput float
- Required only when 'ebs_volume_type' is 'gp3'.
- tier_
level str - The tiering level when 'capacity_tier' is set to 'S3' ['normal','ia','ia-single','intelligent']. The default is 'normal'.
- upgrade_
ontap_ boolversion - Indicates whether to upgrade ontap image with
ontap_version
. To upgrade ontap image,ontap_version
cannot be 'latest' anduse_latest_version
needs to be false. The available versions can be found in BlueXP UI. Click the CVO > click New Version Available under Notifications > the latest available version will be shown. The list of available versions can be found in Select older versions. Update theontap_version
by follow the naming conversion. - use_
latest_ boolversion - Indicates whether to use the latest available ONTAP version. The default is 'true'.
- vpc_
id str - The VPC ID where the working environment will be created. If this argument isn't provided, the VPC will be calculated by using the provided subnet ID.
- workspace_
id str - The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on https://console.bluexp.netapp.com/.
- worm_
retention_ floatperiod_ length - WORM retention period length. Once specified retention period, the WORM is enabled. When WORM storage is activated, data tiering to object storage can’t be enabled.
- worm_
retention_ strperiod_ unit - WORM retention period unit: ['years','months','days','hours','minutes','seconds'].
- writing_
speed_ strstate - The write speed setting for Cloud Volumes ONTAP: ['NORMAL','HIGH']. The default is 'NORMAL'. This argument is not relevant for HA pairs.
- assume
Role StringArn - For HA only, Amazon Resource Name ARN of an AWS Identity and Access Managent IAM role that has created in the VPC owner account. For example, "arn:aws:iam::61239912384567:role/mediator_role_assume_fromdev"
- aws
Encryption StringKms Key Arn - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- aws
Encryption StringKms Key Id - AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
- List<Property Map>
- backup
Volumes BooleanTo Cbs - Automatically enable back up of all volumes to S3 [true, false].
- capacity
Package StringName - The capacity package name: ['Essential', 'Professional', 'Freemium']. Default is 'Essential'.
- capacity
Tier String - Whether to enable data tiering for the first data aggregate: ['S3','NONE']. The default is 'S3'.
- client
Id String - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- cloud
Provider StringAccount - The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector.
- cluster
Floating StringIp - For HA FloatingIP, the cluster management floating IP address.
- cluster
Key StringPair Name - Use for SSH authentication key pair method.
- cvo
Aws StringId - The unique identifier for the working environment.
- data
Encryption StringType - The type of encryption to use for the working environment: ['AWS', 'NONE']. The default is 'AWS'.
- data
Floating StringIp - For HA FloatingIP, the data floating IP address.
- data
Floating StringIp2 - ebs
Volume NumberSize - EBS volume size for the first data aggregate. For GB, the unit can be: [100 or 500]. For TB, the unit can be: [1,2,4,8,16]. The default is '1'.
- ebs
Volume StringSize Unit - ['GB' or 'TB']. The default is 'TB'.
- ebs
Volume StringType - The EBS volume type for the first data aggregate ['gp3', 'gp2','io1','st1','sc1']. The default is 'gp2'.
- enable
Compliance Boolean - Enable the Cloud Compliance service on the working environment [true, false].
- enable
Monitoring Boolean - Enable the Monitoring service on the working environment [true, false]. The default is false.
- failover
Mode String - For HA, the failover mode for the HA pair: ['PrivateIP', 'FloatingIP']. 'PrivateIP' is for a single availability zone and 'FloatingIP' is for multiple availability zones.
- instance
Profile StringName - The instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile.
- instance
Tenancy String - The EC2 instance tenancy: ['default','dedicated']. The default is 'default'.
- instance
Type String - The instance type to use, which depends on the license type: Explore:['m5.xlarge'], Standard:['m5.2xlarge','r5.xlarge'], Premium:['m5.4xlarge','r5.2xlarge','c4.8xlarge'], BYOL: all instance types defined for PayGo. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. The default is 'm5.2xlarge'.
- iops Number
- Provisioned IOPS. Required only when 'ebs_volume_type' is 'io1' or 'gp3'.
- is
Ha Boolean - Indicate whether the working environment is an HA pair or not [true, false]. The default is false.
- kms
Key StringId - license
Type String - The type of license to use. For single node: (by Capacity): ['capacity-paygo'], (by Node paygo): ['cot-explore-paygo','cot-standard-paygo', 'cot-premium-paygo'], (by Node byol): ['cot-premium-byol']. For HA: (by Capacity): ['ha-capacity-paygo'], (by Node paygo): ['ha-cot-explore-paygo','ha-cot-standard-paygo','ha-cot-premium-paygo'], (by Node byol): 'ha-cot-premium-byol']. The default is 'capacity-paygo' for single node, and 'ha-capacity-paygo' for HA.
- mediator
Assign BooleanPublic Ip - bool option to assign public IP. The default is 'true'.
- mediator
Instance StringProfile Name - name of the mediator instance profile.
- mediator
Key StringPair Name - For HA, the key pair name for the mediator instance.
- mediator
Security StringGroup Id - For HA only, mediator security group id.
- mediator
Subnet StringId - For HA, the subnet ID of the mediator.
- name String
- The name of the Cloud Volumes ONTAP working environment.
- node1Subnet
Id String - For HA, the subnet ID of the first node.
- node2Subnet
Id String - For HA, the subnet ID of the second node.
- nss
Account String - The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account isn't provided, Cloud Manager tries to use the first existing NSS account.
- ontap
Version String The required ONTAP version. Ignored if 'use_latest_version' is set to true. The default is to use the latest version. The naming convention:
|Release|Naming convention|Example| |-------|-----------------|-------| |Patch Single |
ONTAP-${version}
| ONTAP-9.13.1P1| |Patch HA |ONTAP-${version}.ha
| ONTAP-9.13.1P1.ha| |Regular Single |ONTAP-${version}.T1
| ONTAP-9.14.0.T1| |Regular HA |ONTAP-${version}.T1.ha
| ONTAP-9.14.0.T1.ha|- optimized
Network BooleanUtilization - Use optimized network utilization [true, false]. The default is true.
- platform
Serial StringNumber - The serial number for the cluster. This is required when 'license_type' is set 'cot-premium-byol'.
- platform
Serial StringNumber Node1 - For HA BYOL, the serial number for the first node. This is required when using 'ha-cot-premium-byol'.
- platform
Serial StringNumber Node2 - For HA BYOL, the serial number for the second node. This is required when using 'ha-cot-premium-byol'.
- provided
License String - region String
- The region where the working environment will be created.
- retries Number
- The number of attempts to wait for the completion of creating the CVO with 60 seconds apart for each attempt. For HA, this value is incremented by 30. The default is '60'.
- route
Table List<String>Ids - For HA FloatingIP, the list of route table IDs that will be updated with the floating IPs.
- saas
Subscription StringId - SaaS Subscription ID. It is needed if the subscription is not paygo type.
- security
Group StringId - The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group.
- subnet
Id String - The subnet id where the working environment will be created. Required when single mode only.
- svm
Floating StringIp - For HA FloatingIP, the SVM management floating IP address.
- svm
Name String - The name of the SVM.
- svm
Password String - The admin password for Cloud Volumes ONTAP.
- throughput Number
- Required only when 'ebs_volume_type' is 'gp3'.
- tier
Level String - The tiering level when 'capacity_tier' is set to 'S3' ['normal','ia','ia-single','intelligent']. The default is 'normal'.
- upgrade
Ontap BooleanVersion - Indicates whether to upgrade ontap image with
ontap_version
. To upgrade ontap image,ontap_version
cannot be 'latest' anduse_latest_version
needs to be false. The available versions can be found in BlueXP UI. Click the CVO > click New Version Available under Notifications > the latest available version will be shown. The list of available versions can be found in Select older versions. Update theontap_version
by follow the naming conversion. - use
Latest BooleanVersion - Indicates whether to use the latest available ONTAP version. The default is 'true'.
- vpc
Id String - The VPC ID where the working environment will be created. If this argument isn't provided, the VPC will be calculated by using the provided subnet ID.
- workspace
Id String - The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on https://console.bluexp.netapp.com/.
- worm
Retention NumberPeriod Length - WORM retention period length. Once specified retention period, the WORM is enabled. When WORM storage is activated, data tiering to object storage can’t be enabled.
- worm
Retention StringPeriod Unit - WORM retention period unit: ['years','months','days','hours','minutes','seconds'].
- writing
Speed StringState - The write speed setting for Cloud Volumes ONTAP: ['NORMAL','HIGH']. The default is 'NORMAL'. This argument is not relevant for HA pairs.
Supporting Types
CvoAwsAwsTag, CvoAwsAwsTagArgs
Package Details
- Repository
- netapp-cloudmanager netapp/terraform-provider-netapp-cloudmanager
- License
- Notes
- This Pulumi package is based on the
netapp-cloudmanager
Terraform Provider.