EcsFunctions

Functions

Link copied to clipboard

This data source provides the Ecs Activations of the current Alibaba Cloud user.

suspend fun getActivations(ids: List<String>? = null, instanceName: String? = null, outputFile: String? = null, pageNumber: Int? = null, pageSize: Int? = null): GetActivationsResult
Link copied to clipboard

This data source provides the Ecs Auto Snapshot Policies of the current Alibaba Cloud user.

suspend fun getAutoSnapshotPolicies(ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, status: String? = null, tags: Map<String, String>? = null): GetAutoSnapshotPoliciesResult
Link copied to clipboard

This data source provides Ecs Capacity Reservation available to the user.

suspend fun getCapacityReservations(capacityReservationIds: List<String>? = null, ids: List<String>? = null, instanceType: String? = null, nameRegex: String? = null, outputFile: String? = null, paymentType: String? = null, platform: String? = null, resourceGroupId: String? = null, status: String? = null, tags: Map<String, String>? = null): GetCapacityReservationsResult
Link copied to clipboard

This data source provides the Ecs Commands of the current Alibaba Cloud user.

suspend fun getCommands(argument: suspend GetCommandsPlainArgsBuilder.() -> Unit): GetCommandsResult
suspend fun getCommands(commandProvider: String? = null, contentEncoding: String? = null, description: String? = null, ids: List<String>? = null, name: String? = null, nameRegex: String? = null, outputFile: String? = null, type: String? = null): GetCommandsResult
Link copied to clipboard

This data source provides the ECS Dedicated Hosts of the current Alibaba Cloud user.

suspend fun getDedicatedHosts(dedicatedHostId: String? = null, dedicatedHostName: String? = null, dedicatedHostType: String? = null, ids: List<String>? = null, nameRegex: String? = null, operationLocks: List<GetDedicatedHostsOperationLock>? = null, outputFile: String? = null, resourceGroupId: String? = null, status: String? = null, tags: Map<String, String>? = null, zoneId: String? = null): GetDedicatedHostsResult
Link copied to clipboard
suspend fun getDisks(argument: GetDisksPlainArgs): GetDisksResult
suspend fun getDisks(argument: suspend GetDisksPlainArgsBuilder.() -> Unit): GetDisksResult
suspend fun getDisks(additionalAttributes: List<String>? = null, autoSnapshotPolicyId: String? = null, availabilityZone: String? = null, category: String? = null, deleteAutoSnapshot: Boolean? = null, deleteWithInstance: Boolean? = null, diskName: String? = null, diskType: String? = null, dryRun: Boolean? = null, enableAutoSnapshot: Boolean? = null, enableAutomatedSnapshotPolicy: Boolean? = null, enableShared: Boolean? = null, encrypted: String? = null, ids: List<String>? = null, instanceId: String? = null, kmsKeyId: String? = null, nameRegex: String? = null, operationLocks: List<GetDisksOperationLock>? = null, outputFile: String? = null, pageNumber: Int? = null, pageSize: Int? = null, paymentType: String? = null, portable: Boolean? = null, resourceGroupId: String? = null, snapshotId: String? = null, status: String? = null, tags: Map<String, String>? = null, type: String? = null, zoneId: String? = null): GetDisksResult
Link copied to clipboard

This data source provides the Ecs Dedicated Host Clusters of the current Alibaba Cloud user.

suspend fun getEcsDedicatedHostClusters(dedicatedHostClusterIds: List<String>? = null, dedicatedHostClusterName: String? = null, ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, tags: Map<String, String>? = null, zoneId: String? = null): GetEcsDedicatedHostClustersResult
Link copied to clipboard

This data source provides the Ecs Deployment Sets of the current Alibaba Cloud user.

suspend fun getEcsDeploymentSets(deploymentSetName: String? = null, ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, strategy: String? = null): GetEcsDeploymentSetsResult
Link copied to clipboard

This data source provides the Ecs Disks of the current Alibaba Cloud user.

suspend fun getEcsDisks(argument: suspend GetEcsDisksPlainArgsBuilder.() -> Unit): GetEcsDisksResult
suspend fun getEcsDisks(additionalAttributes: List<String>? = null, autoSnapshotPolicyId: String? = null, availabilityZone: String? = null, category: String? = null, deleteAutoSnapshot: Boolean? = null, deleteWithInstance: Boolean? = null, diskName: String? = null, diskType: String? = null, dryRun: Boolean? = null, enableAutoSnapshot: Boolean? = null, enableAutomatedSnapshotPolicy: Boolean? = null, enableShared: Boolean? = null, encrypted: String? = null, ids: List<String>? = null, instanceId: String? = null, kmsKeyId: String? = null, nameRegex: String? = null, operationLocks: List<GetEcsDisksOperationLock>? = null, outputFile: String? = null, pageNumber: Int? = null, pageSize: Int? = null, paymentType: String? = null, portable: Boolean? = null, resourceGroupId: String? = null, snapshotId: String? = null, status: String? = null, tags: Map<String, String>? = null, type: String? = null, zoneId: String? = null): GetEcsDisksResult
Link copied to clipboard

This data source provides the Ecs Image Components of the current Alibaba Cloud user.

suspend fun getEcsImageComponents(ids: List<String>? = null, imageComponentName: String? = null, nameRegex: String? = null, outputFile: String? = null, owner: String? = null, resourceGroupId: String? = null, tags: Map<String, String>? = null): GetEcsImageComponentsResult
Link copied to clipboard

This data source provides the Ecs Image Pipelines of the current Alibaba Cloud user.

suspend fun getEcsImagePipeline(ids: List<String>? = null, name: String? = null, nameRegex: String? = null, outputFile: String? = null, resourceGroupId: String? = null, tags: Map<String, String>? = null): GetEcsImagePipelineResult
Link copied to clipboard

This data source provides the Ecs Invocations of the current Alibaba Cloud user.

suspend fun getEcsInvocations(commandId: String? = null, contentEncoding: String? = null, ids: List<String>? = null, invokeStatus: String? = null, outputFile: String? = null, pageNumber: Int? = null, pageSize: Int? = null): GetEcsInvocationsResult
Link copied to clipboard

This data source provides the Ecs Key Pairs of the current Alibaba Cloud user.

suspend fun getEcsKeyPairs(fingerPrint: String? = null, ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, resourceGroupId: String? = null, tags: Map<String, String>? = null): GetEcsKeyPairsResult
Link copied to clipboard

This data source provides the Ecs Launch Templates of the current Alibaba Cloud user.

suspend fun getEcsLaunchTemplates(enableDetails: Boolean? = null, ids: List<String>? = null, launchTemplateName: String? = null, nameRegex: String? = null, outputFile: String? = null, templateResourceGroupId: String? = null, templateTags: Map<String, String>? = null): GetEcsLaunchTemplatesResult
Link copied to clipboard

This data source provides the Ecs Network Interface Permissions of the current Alibaba Cloud user.

suspend fun getEcsNetworkInterfacePermissions(ids: List<String>? = null, networkInterfaceId: String, outputFile: String? = null, pageNumber: Int? = null, pageSize: Int? = null, status: String? = null): GetEcsNetworkInterfacePermissionsResult
Link copied to clipboard

This data source provides the Ecs Network Interfaces of the current Alibaba Cloud user.

suspend fun getEcsNetworkInterfaces(ids: List<String>? = null, instanceId: String? = null, name: String? = null, nameRegex: String? = null, networkInterfaceName: String? = null, outputFile: String? = null, primaryIpAddress: String? = null, privateIp: String? = null, resourceGroupId: String? = null, securityGroupId: String? = null, serviceManaged: Boolean? = null, status: String? = null, tags: Map<String, String>? = null, type: String? = null, vpcId: String? = null, vswitchId: String? = null): GetEcsNetworkInterfacesResult
Link copied to clipboard

This data source provides the Ecs Prefix Lists of the current Alibaba Cloud user.

suspend fun getEcsPrefixLists(addressFamily: String? = null, enableDetails: Boolean? = null, ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null): GetEcsPrefixListsResult
Link copied to clipboard

This data source provides the Ecs Snapshot Groups of the current Alibaba Cloud user.

suspend fun getEcsSnapshotGroups(ids: List<String>? = null, instanceId: String? = null, nameRegex: String? = null, outputFile: String? = null, snapshotGroupName: String? = null, status: String? = null, tags: Map<String, String>? = null): GetEcsSnapshotGroupsResult
Link copied to clipboard

This data source provides the Ecs Snapshots of the current Alibaba Cloud user.

suspend fun getEcsSnapshots(category: String? = null, dryRun: Boolean? = null, encrypted: Boolean? = null, ids: List<String>? = null, kmsKeyId: String? = null, nameRegex: String? = null, outputFile: String? = null, resourceGroupId: String? = null, snapshotLinkId: String? = null, snapshotName: String? = null, snapshotType: String? = null, sourceDiskType: String? = null, status: String? = null, tags: Map<String, String>? = null, type: String? = null, usage: String? = null): GetEcsSnapshotsResult
Link copied to clipboard

This data source provides the Ecs Storage Capacity Units of the current Alibaba Cloud user.

suspend fun getEcsStorageCapacityUnits(ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, status: String? = null): GetEcsStorageCapacityUnitsResult
Link copied to clipboard

This data source provides the Eip Addresses of the current Alibaba Cloud user.

suspend fun getEipAddresses(addressName: String? = null, associatedInstanceId: String? = null, associatedInstanceType: String? = null, dryRun: Boolean? = null, enableDetails: Boolean? = null, ids: List<String>? = null, includeReservationData: Boolean? = null, ipAddress: String? = null, ipAddresses: List<String>? = null, isp: String? = null, lockReason: String? = null, nameRegex: String? = null, outputFile: String? = null, paymentType: String? = null, resourceGroupId: String? = null, segmentInstanceId: String? = null, status: String? = null, tags: Map<String, String>? = null): GetEipAddressesResult
Link copied to clipboard
suspend fun getEips(argument: GetEipsPlainArgs): GetEipsResult
suspend fun getEips(argument: suspend GetEipsPlainArgsBuilder.() -> Unit): GetEipsResult
suspend fun getEips(addressName: String? = null, associatedInstanceId: String? = null, associatedInstanceType: String? = null, dryRun: Boolean? = null, enableDetails: Boolean? = null, ids: List<String>? = null, includeReservationData: Boolean? = null, ipAddress: String? = null, ipAddresses: List<String>? = null, isp: String? = null, lockReason: String? = null, nameRegex: String? = null, outputFile: String? = null, paymentType: String? = null, resourceGroupId: String? = null, segmentInstanceId: String? = null, status: String? = null, tags: Map<String, String>? = null): GetEipsResult
Link copied to clipboard

This data source provides Ecs Elasticity Assurance available to the user.

suspend fun getElasticityAssurances(ids: List<String>? = null, outputFile: String? = null, privatePoolOptionsIds: List<String>? = null, resourceGroupId: String? = null, status: String? = null, tags: Map<String, String>? = null): GetElasticityAssurancesResult
Link copied to clipboard

This data source provides the Ecs Hpc Clusters of the current Alibaba Cloud user.

suspend fun getHpcClusters(ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null): GetHpcClustersResult
Link copied to clipboard

This data source provides available image resources. It contains user's private images, system images provided by Alibaba Cloud, other public images and the ones available on the image market.

suspend fun getImages(argument: suspend GetImagesPlainArgsBuilder.() -> Unit): GetImagesResult
suspend fun getImages(actionType: String? = null, architecture: String? = null, dryRun: Boolean? = null, imageFamily: String? = null, imageId: String? = null, imageName: String? = null, imageOwnerId: String? = null, instanceType: String? = null, isSupportCloudInit: Boolean? = null, isSupportIoOptimized: Boolean? = null, mostRecent: Boolean? = null, nameRegex: String? = null, osType: String? = null, outputFile: String? = null, owners: String? = null, resourceGroupId: String? = null, snapshotId: String? = null, status: String? = null, tags: Map<String, String>? = null, usage: String? = null): GetImagesResult
Link copied to clipboard

Operation to query the reserved keywords of an ApsaraDB RDS instance. The reserved keywords cannot be used for the usernames of accounts or the names of databases.

suspend fun getInstanceKeywords(key: String, outputFile: String? = null): GetInstanceKeywordsResult
Link copied to clipboard

The Instances data source list ECS instance resources according to their ID, name regex, image id, status and other fields.

suspend fun getInstances(availabilityZone: String? = null, enableDetails: Boolean? = null, ids: List<String>? = null, imageId: String? = null, instanceName: String? = null, nameRegex: String? = null, outputFile: String? = null, pageNumber: Int? = null, pageSize: Int? = null, ramRoleName: String? = null, resourceGroupId: String? = null, status: String? = null, tags: Map<String, String>? = null, vpcId: String? = null, vswitchId: String? = null): GetInstancesResult
Link copied to clipboard

This data source provides the ECS instance type families of Alibaba Cloud.

suspend fun getInstanceTypeFamilies(generation: String? = null, instanceChargeType: String? = null, outputFile: String? = null, spotStrategy: String? = null, zoneId: String? = null): GetInstanceTypeFamiliesResult
Link copied to clipboard

This data source provides the ECS instance types of Alibaba Cloud.

suspend fun getInstanceTypes(availabilityZone: String? = null, cpuCoreCount: Int? = null, eniAmount: Int? = null, gpuAmount: Int? = null, gpuSpec: String? = null, imageId: String? = null, instanceChargeType: String? = null, instanceType: String? = null, instanceTypeFamily: String? = null, isOutdated: Boolean? = null, kubernetesNodeRole: String? = null, memorySize: Double? = null, minimumEniIpv6AddressQuantity: Int? = null, minimumEniPrivateIpAddressQuantity: Int? = null, networkType: String? = null, outputFile: String? = null, sortedBy: String? = null, spotStrategy: String? = null, systemDiskCategory: String? = null): GetInstanceTypesResult
Link copied to clipboard
suspend fun getKeyPairs(argument: suspend GetKeyPairsPlainArgsBuilder.() -> Unit): GetKeyPairsResult
suspend fun getKeyPairs(fingerPrint: String? = null, ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, resourceGroupId: String? = null, tags: Map<String, String>? = null): GetKeyPairsResult
Link copied to clipboard
suspend fun getNetworkInterfaces(ids: List<String>? = null, instanceId: String? = null, name: String? = null, nameRegex: String? = null, networkInterfaceName: String? = null, outputFile: String? = null, primaryIpAddress: String? = null, privateIp: String? = null, resourceGroupId: String? = null, securityGroupId: String? = null, serviceManaged: Boolean? = null, status: String? = null, tags: Map<String, String>? = null, type: String? = null, vpcId: String? = null, vswitchId: String? = null): GetNetworkInterfacesResult
Link copied to clipboard

The alicloud.ecs.getSecurityGroupRules data source provides a collection of security permissions of a specific security group. Each collection item represents a single ingress or egress permission rule. The ID of the security group can be provided via a variable or the result from the other data source alicloud.ecs.getSecurityGroups.

suspend fun getSecurityGroupRules(direction: String? = null, groupId: String, ipProtocol: String? = null, nicType: String? = null, outputFile: String? = null, policy: String? = null): GetSecurityGroupRulesResult
Link copied to clipboard

This data source provides a list of Security Groups in an Alibaba Cloud account according to the specified filters.

suspend fun getSecurityGroups(enableDetails: Boolean? = null, ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, pageNumber: Int? = null, pageSize: Int? = null, resourceGroupId: String? = null, tags: Map<String, String>? = null, vpcId: String? = null): GetSecurityGroupsResult
Link copied to clipboard
suspend fun getSnapshots(category: String? = null, dryRun: Boolean? = null, encrypted: Boolean? = null, ids: List<String>? = null, kmsKeyId: String? = null, nameRegex: String? = null, outputFile: String? = null, resourceGroupId: String? = null, snapshotLinkId: String? = null, snapshotName: String? = null, snapshotType: String? = null, sourceDiskType: String? = null, status: String? = null, tags: Map<String, String>? = null, type: String? = null, usage: String? = null): GetSnapshotsResult