Docs Packages
  1. Packages
  2. Scaleway
  3. API Docs
  4. getIpamIp
Scaleway v1.12.1 published on Monday, Apr 15, 2024 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.getIpamIp

Explore with Pulumi AI

scaleway logo
Scaleway v1.12.1 published on Monday, Apr 15, 2024 by pulumiverse
pulumiverse/pulumi-scaleway

    Gets information about IP managed by IPAM service. IPAM service is used for dhcp bundled in VPCs’ private networks.

    Examples

    Using getIpamIp

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIpamIp(args: GetIpamIpArgs, opts?: InvokeOptions): Promise<GetIpamIpResult>
function getIpamIpOutput(args: GetIpamIpOutputArgs, opts?: InvokeOptions): Output<GetIpamIpResult>
    def get_ipam_ip(attached: Optional[bool] = None,
                ipam_ip_id: Optional[str] = None,
                mac_address: Optional[str] = None,
                private_network_id: Optional[str] = None,
                project_id: Optional[str] = None,
                region: Optional[str] = None,
                resource: Optional[GetIpamIpResource] = None,
                tags: Optional[Sequence[str]] = None,
                type: Optional[str] = None,
                zonal: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetIpamIpResult
def get_ipam_ip_output(attached: Optional[pulumi.Input[bool]] = None,
                ipam_ip_id: Optional[pulumi.Input[str]] = None,
                mac_address: Optional[pulumi.Input[str]] = None,
                private_network_id: Optional[pulumi.Input[str]] = None,
                project_id: Optional[pulumi.Input[str]] = None,
                region: Optional[pulumi.Input[str]] = None,
                resource: Optional[pulumi.Input[GetIpamIpResourceArgs]] = None,
                tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                type: Optional[pulumi.Input[str]] = None,
                zonal: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetIpamIpResult]
    func LookupIpamIp(ctx *Context, args *LookupIpamIpArgs, opts ...InvokeOption) (*LookupIpamIpResult, error)
func LookupIpamIpOutput(ctx *Context, args *LookupIpamIpOutputArgs, opts ...InvokeOption) LookupIpamIpResultOutput

    > Note: This function is named LookupIpamIp in the Go SDK.

    public static class GetIpamIp 
{
    public static Task<GetIpamIpResult> InvokeAsync(GetIpamIpArgs args, InvokeOptions? opts = null)
    public static Output<GetIpamIpResult> Invoke(GetIpamIpInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIpamIpResult> getIpamIp(GetIpamIpArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: scaleway:index/getIpamIp:getIpamIp
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Attached bool
    Defines whether to filter only for IPs which are attached to a resource. Cannot be used with ipam_ip_id.
    IpamIpId string
    The IPAM IP ID. Cannot be used with the rest of the arguments.
    MacAddress string
    The Mac Address linked to the IP. Cannot be used with ipam_ip_id.
    PrivateNetworkId string
    The ID of the private network the IP belong to. Cannot be used with ipam_ip_id.
    ProjectId string
    project_id) The ID of the project the IP is associated with.
    Region string
    region) The region in which the IP exists.
    Resource Pulumiverse.Scaleway.Inputs.GetIpamIpResource
    Filter by resource ID, type or name. Cannot be used with ipam_ip_id. If specified, type is required, and at least one of id or name must be set.
    Tags List<string>
    The tags associated with the IP. Cannot be used with ipam_ip_id. As datasource only returns one IP, the search with given tags must return only one result.
    Type string
    The type of the resource to get the IP from. Documentation with type list.
    Zonal string
    Only IPs that are zonal, and in this zone, will be returned.
    Attached bool
    Defines whether to filter only for IPs which are attached to a resource. Cannot be used with ipam_ip_id.
    IpamIpId string
    The IPAM IP ID. Cannot be used with the rest of the arguments.
    MacAddress string
    The Mac Address linked to the IP. Cannot be used with ipam_ip_id.
    PrivateNetworkId string
    The ID of the private network the IP belong to. Cannot be used with ipam_ip_id.
    ProjectId string
    project_id) The ID of the project the IP is associated with.
    Region string
    region) The region in which the IP exists.
    Resource GetIpamIpResource
    Filter by resource ID, type or name. Cannot be used with ipam_ip_id. If specified, type is required, and at least one of id or name must be set.
    Tags []string
    The tags associated with the IP. Cannot be used with ipam_ip_id. As datasource only returns one IP, the search with given tags must return only one result.
    Type string
    The type of the resource to get the IP from. Documentation with type list.
    Zonal string
    Only IPs that are zonal, and in this zone, will be returned.
    attached Boolean
    Defines whether to filter only for IPs which are attached to a resource. Cannot be used with ipam_ip_id.
    ipamIpId String
    The IPAM IP ID. Cannot be used with the rest of the arguments.
    macAddress String
    The Mac Address linked to the IP. Cannot be used with ipam_ip_id.
    privateNetworkId String
    The ID of the private network the IP belong to. Cannot be used with ipam_ip_id.
    projectId String
    project_id) The ID of the project the IP is associated with.
    region String
    region) The region in which the IP exists.
    resource GetIpamIpResource
    Filter by resource ID, type or name. Cannot be used with ipam_ip_id. If specified, type is required, and at least one of id or name must be set.
    tags List<String>
    The tags associated with the IP. Cannot be used with ipam_ip_id. As datasource only returns one IP, the search with given tags must return only one result.
    type String
    The type of the resource to get the IP from. Documentation with type list.
    zonal String
    Only IPs that are zonal, and in this zone, will be returned.
    attached boolean
    Defines whether to filter only for IPs which are attached to a resource. Cannot be used with ipam_ip_id.
    ipamIpId string
    The IPAM IP ID. Cannot be used with the rest of the arguments.
    macAddress string
    The Mac Address linked to the IP. Cannot be used with ipam_ip_id.
    privateNetworkId string
    The ID of the private network the IP belong to. Cannot be used with ipam_ip_id.
    projectId string
    project_id) The ID of the project the IP is associated with.
    region string
    region) The region in which the IP exists.
    resource GetIpamIpResource
    Filter by resource ID, type or name. Cannot be used with ipam_ip_id. If specified, type is required, and at least one of id or name must be set.
    tags string[]
    The tags associated with the IP. Cannot be used with ipam_ip_id. As datasource only returns one IP, the search with given tags must return only one result.
    type string
    The type of the resource to get the IP from. Documentation with type list.
    zonal string
    Only IPs that are zonal, and in this zone, will be returned.
    attached bool
    Defines whether to filter only for IPs which are attached to a resource. Cannot be used with ipam_ip_id.
    ipam_ip_id str
    The IPAM IP ID. Cannot be used with the rest of the arguments.
    mac_address str
    The Mac Address linked to the IP. Cannot be used with ipam_ip_id.
    private_network_id str
    The ID of the private network the IP belong to. Cannot be used with ipam_ip_id.
    project_id str
    project_id) The ID of the project the IP is associated with.
    region str
    region) The region in which the IP exists.
    resource GetIpamIpResource
    Filter by resource ID, type or name. Cannot be used with ipam_ip_id. If specified, type is required, and at least one of id or name must be set.
    tags Sequence[str]
    The tags associated with the IP. Cannot be used with ipam_ip_id. As datasource only returns one IP, the search with given tags must return only one result.
    type str
    The type of the resource to get the IP from. Documentation with type list.
    zonal str
    Only IPs that are zonal, and in this zone, will be returned.
    attached Boolean
    Defines whether to filter only for IPs which are attached to a resource. Cannot be used with ipam_ip_id.
    ipamIpId String
    The IPAM IP ID. Cannot be used with the rest of the arguments.
    macAddress String
    The Mac Address linked to the IP. Cannot be used with ipam_ip_id.
    privateNetworkId String
    The ID of the private network the IP belong to. Cannot be used with ipam_ip_id.
    projectId String
    project_id) The ID of the project the IP is associated with.
    region String
    region) The region in which the IP exists.
    resource Property Map
    Filter by resource ID, type or name. Cannot be used with ipam_ip_id. If specified, type is required, and at least one of id or name must be set.
    tags List<String>
    The tags associated with the IP. Cannot be used with ipam_ip_id. As datasource only returns one IP, the search with given tags must return only one result.
    type String
    The type of the resource to get the IP from. Documentation with type list.
    zonal String
    Only IPs that are zonal, and in this zone, will be returned.

    getIpamIp Result

    The following output properties are available:

    Address string
    The IP address.
    AddressCidr string
    the IP address with a CIDR notation.
    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationId string
    ProjectId string
    Region string
    Zonal string
    Attached bool
    IpamIpId string
    MacAddress string
    PrivateNetworkId string
    Resource Pulumiverse.Scaleway.Outputs.GetIpamIpResource
    Tags List<string>
    Type string
    Address string
    The IP address.
    AddressCidr string
    the IP address with a CIDR notation.
    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationId string
    ProjectId string
    Region string
    Zonal string
    Attached bool
    IpamIpId string
    MacAddress string
    PrivateNetworkId string
    Resource GetIpamIpResource
    Tags []string
    Type string
    address String
    The IP address.
    addressCidr String
    the IP address with a CIDR notation.
    id String
    The provider-assigned unique ID for this managed resource.
    organizationId String
    projectId String
    region String
    zonal String
    attached Boolean
    ipamIpId String
    macAddress String
    privateNetworkId String
    resource GetIpamIpResource
    tags List<String>
    type String
    address string
    The IP address.
    addressCidr string
    the IP address with a CIDR notation.
    id string
    The provider-assigned unique ID for this managed resource.
    organizationId string
    projectId string
    region string
    zonal string
    attached boolean
    ipamIpId string
    macAddress string
    privateNetworkId string
    resource GetIpamIpResource
    tags string[]
    type string
    address str
    The IP address.
    address_cidr str
    the IP address with a CIDR notation.
    id str
    The provider-assigned unique ID for this managed resource.
    organization_id str
    project_id str
    region str
    zonal str
    attached bool
    ipam_ip_id str
    mac_address str
    private_network_id str
    resource GetIpamIpResource
    tags Sequence[str]
    type str
    address String
    The IP address.
    addressCidr String
    the IP address with a CIDR notation.
    id String
    The provider-assigned unique ID for this managed resource.
    organizationId String
    projectId String
    region String
    zonal String
    attached Boolean
    ipamIpId String
    macAddress String
    privateNetworkId String
    resource Property Map
    tags List<String>
    type String

    Supporting Types

    GetIpamIpResource

    Type string
    The type of the resource to get the IP from. Documentation with type list.
    Id string
    The ID of the resource that the IP is bound to.
    Name string
    The name of the resource to get the IP from.
    Type string
    The type of the resource to get the IP from. Documentation with type list.
    Id string
    The ID of the resource that the IP is bound to.
    Name string
    The name of the resource to get the IP from.
    type String
    The type of the resource to get the IP from. Documentation with type list.
    id String
    The ID of the resource that the IP is bound to.
    name String
    The name of the resource to get the IP from.
    type string
    The type of the resource to get the IP from. Documentation with type list.
    id string
    The ID of the resource that the IP is bound to.
    name string
    The name of the resource to get the IP from.
    type str
    The type of the resource to get the IP from. Documentation with type list.
    id str
    The ID of the resource that the IP is bound to.
    name str
    The name of the resource to get the IP from.
    type String
    The type of the resource to get the IP from. Documentation with type list.
    id String
    The ID of the resource that the IP is bound to.
    name String
    The name of the resource to get the IP from.

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.12.1 published on Monday, Apr 15, 2024 by pulumiverse
    pulumiverse/pulumi-scaleway