VpcFunctions

Functions

Link copied to clipboard

This data source provides the Vpc Bgp Groups of the current Alibaba Cloud user.

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

This data source provides the Vpc Bgp Networks of the current Alibaba Cloud user.

suspend fun getBgpNetworks(ids: List<String>? = null, outputFile: String? = null, routerId: String? = null, status: String? = null): GetBgpNetworksResult
Link copied to clipboard

This data source provides the Vpc Bgp Peers of the current Alibaba Cloud user.

suspend fun getBgpPeers(argument: suspend GetBgpPeersPlainArgsBuilder.() -> Unit): GetBgpPeersResult
suspend fun getBgpPeers(bgpGroupId: String? = null, ids: List<String>? = null, outputFile: String? = null, routerId: String? = null, status: String? = null): GetBgpPeersResult
Link copied to clipboard

This data source provides a list of Common Bandwidth Packages owned by an Alibaba Cloud account.

suspend fun getCommonBandwidthPackages(bandwidthPackageName: String? = null, dryRun: Boolean? = null, ids: List<String>? = null, includeReservationData: Boolean? = null, nameRegex: String? = null, outputFile: String? = null, resourceGroupId: String? = null, status: String? = null): GetCommonBandwidthPackagesResult
Link copied to clipboard

This data source provides the Vpc Dhcp Options Sets of the current Alibaba Cloud user.

suspend fun getDhcpOptionsSets(dhcpOptionsSetName: String? = null, domainName: String? = null, ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, status: String? = null): GetDhcpOptionsSetsResult
Link copied to clipboard
Link copied to clipboard

Using this data source can open Vpc Flow Log service automatically. If the service has been opened, it will return opened. For information about Vpc Flow Log and how to use it, see What is Vpc Flow Log.

suspend fun getFlowLogService(enable: String? = null): GetFlowLogServiceResult
Link copied to clipboard

This data source provides a list of Forward Entries owned by an Alibaba Cloud account.

suspend fun getForwardEntries(externalIp: String? = null, externalPort: String? = null, forwardEntryName: String? = null, forwardTableId: String, ids: List<String>? = null, internalIp: String? = null, internalPort: String? = null, ipProtocol: String? = null, nameRegex: String? = null, outputFile: String? = null, status: String? = null): GetForwardEntriesResult
Link copied to clipboard

This data source provides the Havips of the current Alibaba Cloud user.

suspend fun getHavips(argument: suspend GetHavipsPlainArgsBuilder.() -> Unit): GetHavipsResult
suspend fun getHavips(ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, status: String? = null): GetHavipsResult
Link copied to clipboard

This data source provides Vpc Ipam Ipam Pool Allocation available to the user.What is Ipam Pool Allocation

suspend fun getIpamIpamPoolAllocations(cidr: String? = null, ids: List<String>? = null, ipamPoolAllocationId: String? = null, ipamPoolAllocationName: String? = null, ipamPoolId: String, nameRegex: String? = null, outputFile: String? = null): GetIpamIpamPoolAllocationsResult
Link copied to clipboard

This data source provides Vpc Ipam Ipam Pool Cidr available to the user.What is Ipam Pool Cidr

suspend fun getIpamIpamPoolCidrs(cidr: String? = null, ipamPoolId: String, outputFile: String? = null): GetIpamIpamPoolCidrsResult
Link copied to clipboard

This data source provides Vpc Ipam Ipam Pool available to the user.What is Ipam Pool

suspend fun getIpamIpamPools(ids: List<String>? = null, ipamPoolId: String? = null, ipamPoolName: String? = null, ipamScopeId: String? = null, nameRegex: String? = null, outputFile: String? = null, poolRegionId: String? = null, resourceGroupId: String? = null, sourceIpamPoolId: String? = null, tags: Map<String, String>? = null): GetIpamIpamPoolsResult
Link copied to clipboard

This data source provides Vpc Ipam Ipam available to the user.What is Ipam

suspend fun getIpamIpams(ids: List<String>? = null, ipamId: String? = null, ipamName: String? = null, nameRegex: String? = null, outputFile: String? = null, resourceGroupId: String? = null, tags: Map<String, String>? = null): GetIpamIpamsResult
Link copied to clipboard

This data source provides Vpc Ipam Ipam Scope available to the user.What is Ipam Scope

suspend fun getIpamIpamScopes(ids: List<String>? = null, ipamId: String? = null, ipamScopeId: String? = null, ipamScopeName: String? = null, ipamScopeType: String? = null, nameRegex: String? = null, outputFile: String? = null, resourceGroupId: String? = null, tags: Map<String, String>? = null): GetIpamIpamScopesResult
Link copied to clipboard

This data source provides the Vpn Ipsec Servers of the current Alibaba Cloud user.

suspend fun getIpsecServers(ids: List<String>? = null, ipsecServerName: String? = null, nameRegex: String? = null, outputFile: String? = null, vpnGatewayId: String? = null): GetIpsecServersResult
Link copied to clipboard

This data source provides the Vpc Ipv4 Gateways of the current Alibaba Cloud user.

suspend fun getIpv4Gateways(ids: List<String>? = null, ipv4GatewayName: String? = null, nameRegex: String? = null, outputFile: String? = null, status: String? = null, vpcId: String? = null): GetIpv4GatewaysResult
Link copied to clipboard

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

suspend fun getIpv6Addresses(associatedInstanceId: String? = null, ids: List<String>? = null, outputFile: String? = null, status: String? = null, vpcId: String? = null, vswitchId: String? = null): GetIpv6AddressesResult
Link copied to clipboard

This data source provides the Vpc Ipv6 Egress Rules of the current Alibaba Cloud user.

suspend fun getIpv6EgressRules(ids: List<String>? = null, instanceId: String? = null, ipv6EgressRuleName: String? = null, ipv6GatewayId: String, nameRegex: String? = null, outputFile: String? = null, status: String? = null): GetIpv6EgressRulesResult
Link copied to clipboard

This data source provides the Vpc Ipv6 Gateways of the current Alibaba Cloud user.

suspend fun getIpv6Gateways(ids: List<String>? = null, ipv6GatewayName: String? = null, nameRegex: String? = null, outputFile: String? = null, status: String? = null, vpcId: String? = null): GetIpv6GatewaysResult
Link copied to clipboard

This data source provides the Vpc Ipv6 Internet Bandwidths of the current Alibaba Cloud user.

suspend fun getIpv6InternetBandwidths(ids: List<String>? = null, ipv6AddressId: String? = null, ipv6InternetBandwidthId: String? = null, outputFile: String? = null, status: String? = null): GetIpv6InternetBandwidthsResult
Link copied to clipboard

This data source provides a list of Nat Gateways owned by an Alibaba Cloud account.

suspend fun getNatGateways(dryRun: Boolean? = null, enableDetails: Boolean? = null, ids: List<String>? = null, nameRegex: String? = null, natGatewayName: String? = null, natType: String? = null, outputFile: String? = null, pageNumber: Int? = null, pageSize: Int? = null, paymentType: String? = null, resourceGroupId: String? = null, specification: String? = null, status: String? = null, tags: Map<String, String>? = null, vpcId: String? = null): GetNatGatewaysResult
Link copied to clipboard

This data source provides the Vpc Nat Ip Cidrs of the current Alibaba Cloud user.

suspend fun getNatIpCidrs(ids: List<String>? = null, nameRegex: String? = null, natGatewayId: String, natIpCidrNames: List<String>? = null, natIpCidrs: List<String>? = null, outputFile: String? = null, status: String? = null): GetNatIpCidrsResult
Link copied to clipboard

This data source provides the Vpc Nat Ips of the current Alibaba Cloud user.

suspend fun getNatIps(argument: suspend GetNatIpsPlainArgsBuilder.() -> Unit): GetNatIpsResult
suspend fun getNatIps(ids: List<String>? = null, nameRegex: String? = null, natGatewayId: String, natIpCidr: String? = null, natIpIds: List<String>? = null, natIpNames: List<String>? = null, outputFile: String? = null, status: String? = null): GetNatIpsResult
Link copied to clipboard

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

suspend fun getNetworkAcls(ids: List<String>? = null, nameRegex: String? = null, networkAclName: String? = null, outputFile: String? = null, resourceId: String? = null, resourceType: String? = null, status: String? = null, vpcId: String? = null): GetNetworkAclsResult
Link copied to clipboard

This data source provides VPCs available to the user.

suspend fun getNetworks(argument: suspend GetNetworksPlainArgsBuilder.() -> Unit): GetNetworksResult
suspend fun getNetworks(cidrBlock: String? = null, dhcpOptionsSetId: String? = null, dryRun: Boolean? = null, enableDetails: Boolean? = null, ids: List<String>? = null, isDefault: Boolean? = null, nameRegex: String? = null, outputFile: String? = null, pageNumber: Int? = null, pageSize: Int? = null, resourceGroupId: String? = null, status: String? = null, tags: Map<String, String>? = null, vpcName: String? = null, vpcOwnerId: Int? = null, vswitchId: String? = null): GetNetworksResult
Link copied to clipboard
Link copied to clipboard

This data source provides the Vpc Peer Connections of the current Alibaba Cloud user.

suspend fun getPeerConnections(ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, peerConnectionName: String? = null, status: String? = null, vpcId: String? = null): GetPeerConnectionsResult
Link copied to clipboard

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

suspend fun getPrefixLists(enableDetails: Boolean? = null, ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, prefixListName: String? = null): GetPrefixListsResult
Link copied to clipboard

This data source provides the Vpc Public Ip Address Pool Cidr Blocks of the current Alibaba Cloud user.

suspend fun getPublicIpAddressPoolCidrBlocks(cidrBlock: String? = null, ids: List<String>? = null, outputFile: String? = null, publicIpAddressPoolId: String, status: String? = null): GetPublicIpAddressPoolCidrBlocksResult
Link copied to clipboard

This data source provides the Vpc Public Ip Address Pools of the current Alibaba Cloud user.

suspend fun getPublicIpAddressPools(ids: List<String>? = null, isp: String? = null, nameRegex: String? = null, outputFile: String? = null, publicIpAddressPoolIds: List<String>? = null, publicIpAddressPoolName: String? = null, status: String? = null): GetPublicIpAddressPoolsResult
Link copied to clipboard

This data source provides a list of Route Entries owned by an Alibaba Cloud account.

suspend fun getRouteEntries(cidrBlock: String? = null, instanceId: String? = null, outputFile: String? = null, routeTableId: String, type: String? = null): GetRouteEntriesResult
Link copied to clipboard

This data source provides information about router interfaces that connect VPCs together.

suspend fun getRouterInterfaces(ids: List<String>? = null, nameRegex: String? = null, oppositeInterfaceId: String? = null, oppositeInterfaceOwnerId: String? = null, outputFile: String? = null, role: String? = null, routerId: String? = null, routerType: String? = null, specification: String? = null, status: String? = null): GetRouterInterfacesResult
Link copied to clipboard

This data source provides a list of Route Tables owned by an Alibaba Cloud account.

suspend fun getRouteTables(ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, pageNumber: Int? = null, pageSize: Int? = null, resourceGroupId: String? = null, routeTableName: String? = null, routeTableType: String? = null, routerId: String? = null, routerType: String? = null, status: String? = null, tags: Map<String, String>? = null, vpcId: String? = null): GetRouteTablesResult
Link copied to clipboard

This data source provides a list of Snat Entries owned by an Alibaba Cloud account.

suspend fun getSnatEntries(ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, snatEntryName: String? = null, snatIp: String? = null, snatTableId: String, sourceCidr: String? = null, sourceVswitchId: String? = null, status: String? = null): GetSnatEntriesResult
Link copied to clipboard

The SSL-VPN client certificates data source lists lots of SSL-VPN client certificates resource information owned by an Alicloud account.

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

The SSL-VPN servers data source lists lots of SSL-VPN servers resource information owned by an Alicloud account.

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

This data source provides a list of VSwitches owned by an Alibaba Cloud account.

suspend fun getSwitches(argument: suspend GetSwitchesPlainArgsBuilder.() -> Unit): GetSwitchesResult
suspend fun getSwitches(cidrBlock: String? = null, dryRun: Boolean? = null, ids: List<String>? = null, isDefault: Boolean? = null, nameRegex: String? = null, outputFile: String? = null, resourceGroupId: String? = null, routeTableId: String? = null, status: String? = null, tags: Map<String, String>? = null, vpcId: String? = null, vswitchName: String? = null, vswitchOwnerId: Int? = null, zoneId: String? = null): GetSwitchesResult
Link copied to clipboard

This data source provides the Vpc Traffic Mirror Filter Egress Rules of the current Alibaba Cloud user.

suspend fun getTrafficMirrorFilterEgressRules(ids: List<String>? = null, outputFile: String? = null, status: String? = null, trafficMirrorFilterId: String): GetTrafficMirrorFilterEgressRulesResult
Link copied to clipboard

This data source provides the Vpc Traffic Mirror Filter Ingress Rules of the current Alibaba Cloud user.

suspend fun getTrafficMirrorFilterIngressRules(ids: List<String>? = null, outputFile: String? = null, status: String? = null, trafficMirrorFilterId: String): GetTrafficMirrorFilterIngressRulesResult
Link copied to clipboard

This data source provides the Vpc Traffic Mirror Filters of the current Alibaba Cloud user.

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

Using this data source can open VPC Traffic Mirror service automatically. If the service has been opened, it will return opened. For information about VPC Traffic Mirror and how to use it, see What is VPC Traffic Mirror.

Link copied to clipboard

This data source provides the Vpc Traffic Mirror Sessions of the current Alibaba Cloud user.

suspend fun getTrafficMirrorSessions(enabled: Boolean? = null, ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, priority: Int? = null, status: String? = null, trafficMirrorFilterId: String? = null, trafficMirrorSessionName: String? = null, trafficMirrorSourceId: String? = null, trafficMirrorTargetId: String? = null): GetTrafficMirrorSessionsResult
Link copied to clipboard

This data source provides the Vpc Flow Logs of the current Alibaba Cloud user.

suspend fun getVpcFlowLogs(description: String? = null, flowLogName: String? = null, ids: List<String>? = null, logStoreName: String? = null, nameRegex: String? = null, outputFile: String? = null, projectName: String? = null, resourceId: String? = null, resourceType: String? = null, status: String? = null, trafficType: String? = null): GetVpcFlowLogsResult