Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Constellix Provider
  3. API Docs
  4. GeoProximity
constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix
constellix/terraform-provider-constellix

constellix.GeoProximity

Explore with Pulumi AI

constellix logo
constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix
constellix/terraform-provider-constellix

    Create GeoProximity Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GeoProximity(name: string, args?: GeoProximityArgs, opts?: CustomResourceOptions);
    @overload
def GeoProximity(resource_name: str,
                 args: Optional[GeoProximityArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def GeoProximity(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 city: Optional[float] = None,
                 country: Optional[str] = None,
                 geo_proximity_id: Optional[str] = None,
                 latitude: Optional[float] = None,
                 longitude: Optional[float] = None,
                 name: Optional[str] = None,
                 region: Optional[str] = None)
    func NewGeoProximity(ctx *Context, name string, args *GeoProximityArgs, opts ...ResourceOption) (*GeoProximity, error)
    public GeoProximity(string name, GeoProximityArgs? args = null, CustomResourceOptions? opts = null)
    public GeoProximity(String name, GeoProximityArgs args)
public GeoProximity(String name, GeoProximityArgs args, CustomResourceOptions options)

    type: constellix:GeoProximity
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 GeoProximityArgs
    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 GeoProximityArgs
    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 GeoProximityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GeoProximityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GeoProximityArgs
    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 geoProximityResource = new Constellix.GeoProximity("geoProximityResource", new()
{
    City = 0,
    Country = "string",
    GeoProximityId = "string",
    Latitude = 0,
    Longitude = 0,
    Name = "string",
    Region = "string",
});

    example, err := constellix.NewGeoProximity(ctx, "geoProximityResource", &constellix.GeoProximityArgs{
City: pulumi.Float64(0),
Country: pulumi.String("string"),
GeoProximityId: pulumi.String("string"),
Latitude: pulumi.Float64(0),
Longitude: pulumi.Float64(0),
Name: pulumi.String("string"),
Region: pulumi.String("string"),
})

    var geoProximityResource = new GeoProximity("geoProximityResource", GeoProximityArgs.builder()
    .city(0)
    .country("string")
    .geoProximityId("string")
    .latitude(0)
    .longitude(0)
    .name("string")
    .region("string")
    .build());

    geo_proximity_resource = constellix.GeoProximity("geoProximityResource",
    city=0,
    country="string",
    geo_proximity_id="string",
    latitude=0,
    longitude=0,
    name="string",
    region="string")

    const geoProximityResource = new constellix.GeoProximity("geoProximityResource", {
    city: 0,
    country: "string",
    geoProximityId: "string",
    latitude: 0,
    longitude: 0,
    name: "string",
    region: "string",
});

    type: constellix:GeoProximity
properties:
    city: 0
    country: string
    geoProximityId: string
    latitude: 0
    longitude: 0
    name: string
    region: string

    GeoProximity 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 GeoProximity resource accepts the following input properties:

    City double
    Country string
    GeoProximityId string
    The constellix calculated id of the Geo Proximity resource.
    Latitude double
    Longitude double
    Name string
    Region string
    City float64
    Country string
    GeoProximityId string
    The constellix calculated id of the Geo Proximity resource.
    Latitude float64
    Longitude float64
    Name string
    Region string
    city Double
    country String
    geoProximityId String
    The constellix calculated id of the Geo Proximity resource.
    latitude Double
    longitude Double
    name String
    region String
    city number
    country string
    geoProximityId string
    The constellix calculated id of the Geo Proximity resource.
    latitude number
    longitude number
    name string
    region string
    city float
    country str
    geo_proximity_id str
    The constellix calculated id of the Geo Proximity resource.
    latitude float
    longitude float
    name str
    region str
    city Number
    country String
    geoProximityId String
    The constellix calculated id of the Geo Proximity resource.
    latitude Number
    longitude Number
    name String
    region String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GeoProximity 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 GeoProximity Resource

    Get an existing GeoProximity 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?: GeoProximityState, opts?: CustomResourceOptions): GeoProximity
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        city: Optional[float] = None,
        country: Optional[str] = None,
        geo_proximity_id: Optional[str] = None,
        latitude: Optional[float] = None,
        longitude: Optional[float] = None,
        name: Optional[str] = None,
        region: Optional[str] = None) -> GeoProximity
    func GetGeoProximity(ctx *Context, name string, id IDInput, state *GeoProximityState, opts ...ResourceOption) (*GeoProximity, error)
    public static GeoProximity Get(string name, Input<string> id, GeoProximityState? state, CustomResourceOptions? opts = null)
    public static GeoProximity get(String name, Output<String> id, GeoProximityState state, CustomResourceOptions options)
    resources:  _:    type: constellix:GeoProximity    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.
    The following state arguments are supported:
    City double
    Country string
    GeoProximityId string
    The constellix calculated id of the Geo Proximity resource.
    Latitude double
    Longitude double
    Name string
    Region string
    City float64
    Country string
    GeoProximityId string
    The constellix calculated id of the Geo Proximity resource.
    Latitude float64
    Longitude float64
    Name string
    Region string
    city Double
    country String
    geoProximityId String
    The constellix calculated id of the Geo Proximity resource.
    latitude Double
    longitude Double
    name String
    region String
    city number
    country string
    geoProximityId string
    The constellix calculated id of the Geo Proximity resource.
    latitude number
    longitude number
    name string
    region string
    city float
    country str
    geo_proximity_id str
    The constellix calculated id of the Geo Proximity resource.
    latitude float
    longitude float
    name str
    region str
    city Number
    country String
    geoProximityId String
    The constellix calculated id of the Geo Proximity resource.
    latitude Number
    longitude Number
    name String
    region String

    Package Details

    Repository
    constellix constellix/terraform-provider-constellix
    License
    Notes
    This Pulumi package is based on the constellix Terraform Provider.
    constellix logo
    constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix
    constellix/terraform-provider-constellix