AWS API¶
zCompute provides compatibility with the following tables of APIs that list the required, optional, ignored and unsupported parameters.
Important
Although zCompute ignores the region parameter, a valid AWS region is a required parameter. Some tools can fail or return errors without the region parameter.
The following Terraform snippet demonstrates an example definition of a required valid AWS region that is ignored by zCompute:
provider "aws" {
access_key = var.access_key
secret_key = var.secret_key
# shared_credentials = var.credentials_file
version = "=3.0.0"
endpoints {
elb = "https://${var.zCompute_ip}/api/v2/aws/elb"
ec2 = "https://${var.zCompute_ip}/api/v2/aws/ec2"
}
insecure = true
skip_metadata_api_check = true
skip_credentials_validation = true
skip_requesting_account_id = true
# Required valid AWS region, currently ignored by zCompute
region = "us-east-2"
}
AWS EC2¶
AWS API Reference |
Ignored Param |
Optional Parameters |
Required Parameters |
Unsupported Params |
---|---|---|---|---|
[] |
Address |
[] |
[] |
|
[] |
InstanceId NetworkInterfaceId PrivateIpAddress |
AllocationId |
[] |
|
[] |
[] |
IamInstanceProfile InstanceId |
[] |
|
[] |
GroupId GroupName IpPermissions CidrIp FromPort IpProtocol ToPort SourceSecurityGroupName |
[] |
[] |
|
[] |
Description BlockDeviceMapping NoReboot |
InstanceId Name |
[] |
|
[] |
[] |
KeyName |
[] |
|
[] |
[] |
GroupDescription GroupName VpcId |
[] |
|
[] |
[] |
ResourceId Tag |
[] |
|
[] |
[] |
KeyName |
[] |
|
[] |
GroupId GroupName |
[] |
[] |
|
[] |
[] |
ResourceId Tag |
[] |
|
[] |
[] |
ImageId |
[] |
|
[] |
AttributeName |
[] |
[] |
|
[] |
AllocationId PublicIp Filter |
[] |
[] |
|
[] |
[] |
[] |
[] |
|
[] |
AssociationIds |
[] |
[] |
|
[] |
[] |
ImageId Attribute |
[] |
|
[] |
ExecutableBy Filter ImageId Owner |
[] |
[] |
|
[] |
[] |
InstanceId Attribute |
[] |
|
[] |
[] |
InstanceId |
[] |
|
[] |
InstanceId Filter MaxResults NextToken |
[] |
[] |
|
[] |
KeyName Filter |
[] |
[] |
|
[] |
[] |
[] |
[] |
|
[] |
GroupId GroupName Filter |
[] |
[] |
|
[] |
[] |
[] |
[] |
|
[] |
Filter MaxResults NextToken |
[] |
[] |
|
[] |
[] |
AssociationId |
[] |
|
[] |
[] |
AssociationId |
[] |
|
[] |
[] |
InstanceId |
[] |
|
[] |
[] |
InstanceId |
[] |
|
[] |
[] |
KeyName PublicKeyMaterial |
[] |
|
[] |
Attribute Description LaunchPermission OperationType ProductCode UserGroup UserId Value |
ImageId |
[] |
|
[] |
Attribute Value InstanceType DisableApiTermination SourceDestCheck GroupId Kernel Ramdisk InstanceInitiatedShutdownBehavior RootDeviceName ProductCodes EbsOptimized SriovNetSupport EnaSupport UserData BlockDeviceMapping |
InstanceId |
[] |
|
[] |
[] |
InstanceId |
[] |
|
[] |
Architecture BillingProduct BlockDeviceMapping Description EnaSupport ImageLocation KernelId RamdiskId RootDeviceName SriovNetSupport VirtualizationType |
Name |
[] |
|
[] |
[] |
AllocationId |
[] |
|
[] |
LaunchPermission |
ImageId |
[] |
|
[] |
[] |
InstanceId Attribute |
[] |
|
[] |
InstanceType KeyName NetworkInterface PrivateIpAddress SecurityGroup SecurityGroupId SubnetId TagSpecification UserData EbsOptimized BlockDeviceMapping DisableApiTermination Monitoring Placement IamInstanceProfile |
MinCount MaxCount ImageId |
[] |
|
[] |
[] |
InstanceId |
[] |
|
[] |
Force |
InstanceId |
[] |
|
[] |
[] |
InstanceId |
[] |
AWS-Import/Export VMs¶
AWS API Reference |
Ignored Param |
Optional Parameters |
Required Parameters |
Unsupported Params |
---|---|---|---|---|
[] |
Filters ImportTaskId MaxResults NextToken |
[] |
[] |
|
[] |
Architecture ClientData ClientToken Description DiskContainer Hypervisor LicenseType Platform RoleName |
[] |
[] |
AWS-EC2-AutoScalingGroups¶
AWS API Reference |
Ignored Param |
Optional Parameters |
Required Parameters |
Unsupported Params |
---|---|---|---|---|
[] |
[] |
AutoScalingGroupName InstanceIds |
[] |
|
[] |
[] |
AutoScalingGroupName TargetGroupARNs |
[] |
|
[] |
AvailabilityZones DefaultCooldown DesiredCapacity HealthCheckGracePeriod HealthCheckType NewInstancesProtectedFromScaleIn ServiceLinkedRoleARN Tags TargetGroupARNs TerminationPolicies VPCZoneIdentifier |
AutoScalingGroupName LaunchConfigurationName MaxSize MinSize |
InstanceId LaunchTemplate LifecycleHookSpecificationList LoadBalancerNames PlacementGroup |
|
RamdiskId InstanceMonitoring EbsOptimized AssociatePublicIpAddress PlacementTenancy |
KeyName InstanceType SecurityGroups UserData BlockDeviceMappings RamdiskId InstanceMonitoring EbsOptimized AssociatePublicIpAddress PlacementTenancy |
LaunchConfigurationName ImageId |
InstanceId ClassicLinkVPCId ClassicLinkVPCSecurityGroups IamInstanceProfile KernelId SpotPrice |
|
[] |
Tags |
[] |
[] |
|
[] |
ForceDelete |
AutoScalingGroupName |
[] |
|
[] |
[] |
LaunchConfigurationName |
[] |
|
[] |
[] |
PolicyName AutoScalingGroupName |
[] |
|
[] |
[] |
AutoScalingGroupName ScheduledActionName |
[] |
|
[] |
Tags |
[] |
[] |
|
[] |
AutoScalingGroupNames |
[] |
MaxRecords NextToken |
|
[] |
LaunchConfigurationNames |
[] |
[] |
|
[] |
AutoScalingGroupName PolicyNames PolicyTypes |
[] |
[] |
|
ActivityIds AutoScalingGroupName MaxRecords NextToken |
ActivityIds AutoScalingGroupName MaxRecords NextToken |
[] |
[] |
|
[] |
AutoScalingGroupName EndTime StartTime ScheduledActionNames |
[] |
MaxRecords NextToken |
|
[] |
Filters |
[] |
MaxRecords NextToken |
|
[] |
[] |
AutoScalingGroupName InstanceIds ShouldDecrementDesiredCapacity |
[] |
|
[] |
[] |
AutoScalingGroupName TargetGroupARNs |
[] |
|
[] |
[] |
AutoScalingGroupName InstanceIds ShouldDecrementDesiredCapacity |
[] |
|
[] |
[] |
AutoScalingGroupName InstanceIds |
[] |
|
[] |
PolicyType EstimatedInstanceWarmup TargetTrackingConfiguration |
PolicyName AutoScalingGroupName |
AdjustmentType Cooldown MetricAggregationType MinAdjustmentMagnitude MinAdjustmentStep ScalingAdjustment StepAdjustments |
|
Time |
DesiredCapacity EndTime MaxSize MinSize Recurrence StartTime Time |
AutoScalingGroupName ScheduledActionName |
[] |
|
[] |
AvailabilityZones DefaultCooldown DesiredCapacity HealthCheckGracePeriod HealthCheckType LaunchConfigurationName MaxSize MinSize NewInstancesProtectedFromScaleIn ServiceLinkedRoleARN TerminationPolicies VPCZoneIdentifier |
AutoScalingGroupName |
LaunchTemplate PlacementGroup |
AWS-EBS¶
AWS API Reference |
Ignored Param |
Optional Parameters |
Required Parameters |
Unsupported Params |
---|---|---|---|---|
[] |
[] |
Device InstanceId VolumeId |
[] |
|
[] |
Description TagSpecification |
VolumeId |
[] |
|
[] |
Size SnapshotId TagSpecification VolumeType |
AvailabilityZone |
[] |
|
[] |
[] |
SnapshotId |
[] |
|
[] |
[] |
VolumeId |
[] |
|
[] |
SnapshotId Owner Filter MaxResults |
[] |
[] |
|
[] |
VolumeId Filter MaxResults |
[] |
[] |
|
[] |
Device InstanceId Force |
VolumeId |
[] |
|
[] |
Iops Size VolumeType |
VolumeId |
[] |
AWS-SNS¶
AWS API Reference |
Ignored Param |
Optional Parameters |
Required Parameters |
Unsupported Params |
---|---|---|---|---|
[] |
[] |
Name |
[] |
|
[] |
[] |
TopicArn |
[] |
|
[] |
[] |
TopicArn |
[] |
|
[] |
NextToken |
[] |
[] |
|
[] |
[] |
ResourceArn |
[] |
|
[] |
NextToken |
[] |
[] |
|
[] |
MessageAttributes MessageStructure PhoneNumber Subject TargetArn TopicArn |
Message |
[] |
|
[] |
[] |
TopicArn |
[] |
|
[] |
Attributes Endpoint Protocol ReturnSubscriptionArn |
TopicArn Protocol |
[] |
|
[] |
SubscriptionArn |
[] |
AWS-CloudWatch¶
AWS API Reference |
Ignored Param |
Optional Parameters |
Required Parameters |
Unsupported Params |
---|---|---|---|---|
[] |
[] |
AlarmNames |
[] |
|
[] |
AlarmName EndDate HistoryItemType MaxRecords NextToken StartDate |
[] |
[] |
|
[] |
ActionPrefix AlarmNamePrefix AlarmNames MaxRecords NextToken StateValue |
[] |
[] |
|
[] |
[] |
AlarmNames |
[] |
|
[] |
[] |
AlarmNames |
[] |
|
[] |
MetricName Namespace |
[] |
[] |
|
[] |
[] |
ResourceARN |
[] |
|
[] |
ActionsEnabled AlarmActions AlarmDescription DatapointsToAlarm Dimensions EvaluateLowSampleCountPercentile ExtendedStatistic InsufficientDataActions OKActions Statistic TreatMissingData Unit |
AlarmName ComparisonOperator EvaluationPeriods MetricName Namespace Period Threshold |
[] |
|
[] |
StateReasonData |
AlarmName StateReason StateValue |
[] |