1. Packages
  2. Avi Provider
  3. API Docs
  4. getFederationcheckpoint
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

avi.getFederationcheckpoint

Explore with Pulumi AI

<!–

Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

–>

layout: “avi”

page_title: “AVI: avi.Federationcheckpoint” sidebar_current: “docs-avi-datasource-federationcheckpoint” description: |- Get information of Avi FederationCheckpoint.

avi.Federationcheckpoint

This data source is used to to get avi.Federationcheckpoint objects.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as avi from "@pulumi/avi";

const fooFederationcheckpoint = avi.getFederationcheckpoint({
    name: "foo",
    uuid: "federationcheckpoint-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
});
Copy
import pulumi
import pulumi_avi as avi

foo_federationcheckpoint = avi.get_federationcheckpoint(name="foo",
    uuid="federationcheckpoint-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.LookupFederationcheckpoint(ctx, &avi.LookupFederationcheckpointArgs{
			Name: pulumi.StringRef("foo"),
			Uuid: pulumi.StringRef("federationcheckpoint-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var fooFederationcheckpoint = Avi.GetFederationcheckpoint.Invoke(new()
    {
        Name = "foo",
        Uuid = "federationcheckpoint-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.AviFunctions;
import com.pulumi.avi.inputs.GetFederationcheckpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var fooFederationcheckpoint = AviFunctions.getFederationcheckpoint(GetFederationcheckpointArgs.builder()
            .name("foo")
            .uuid("federationcheckpoint-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .build());

    }
}
Copy
variables:
  fooFederationcheckpoint:
    fn::invoke:
      function: avi:getFederationcheckpoint
      arguments:
        name: foo
        uuid: federationcheckpoint-f9cf6b3e-a411-436f-95e2-2982ba2b217b
Copy

Using getFederationcheckpoint

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 getFederationcheckpoint(args: GetFederationcheckpointArgs, opts?: InvokeOptions): Promise<GetFederationcheckpointResult>
function getFederationcheckpointOutput(args: GetFederationcheckpointOutputArgs, opts?: InvokeOptions): Output<GetFederationcheckpointResult>
Copy
def get_federationcheckpoint(id: Optional[str] = None,
                             name: Optional[str] = None,
                             tenant_ref: Optional[str] = None,
                             uuid: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetFederationcheckpointResult
def get_federationcheckpoint_output(id: Optional[pulumi.Input[str]] = None,
                             name: Optional[pulumi.Input[str]] = None,
                             tenant_ref: Optional[pulumi.Input[str]] = None,
                             uuid: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetFederationcheckpointResult]
Copy
func LookupFederationcheckpoint(ctx *Context, args *LookupFederationcheckpointArgs, opts ...InvokeOption) (*LookupFederationcheckpointResult, error)
func LookupFederationcheckpointOutput(ctx *Context, args *LookupFederationcheckpointOutputArgs, opts ...InvokeOption) LookupFederationcheckpointResultOutput
Copy

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

public static class GetFederationcheckpoint 
{
    public static Task<GetFederationcheckpointResult> InvokeAsync(GetFederationcheckpointArgs args, InvokeOptions? opts = null)
    public static Output<GetFederationcheckpointResult> Invoke(GetFederationcheckpointInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFederationcheckpointResult> getFederationcheckpoint(GetFederationcheckpointArgs args, InvokeOptions options)
public static Output<GetFederationcheckpointResult> getFederationcheckpoint(GetFederationcheckpointArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: avi:index/getFederationcheckpoint:getFederationcheckpoint
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
Name string
Search FederationCheckpoint by name.
TenantRef string
Tenant that this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Search FederationCheckpoint by uuid.
Id string
Name string
Search FederationCheckpoint by name.
TenantRef string
Tenant that this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Search FederationCheckpoint by uuid.
id String
name String
Search FederationCheckpoint by name.
tenantRef String
Tenant that this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Search FederationCheckpoint by uuid.
id string
name string
Search FederationCheckpoint by name.
tenantRef string
Tenant that this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string
Search FederationCheckpoint by uuid.
id str
name str
Search FederationCheckpoint by name.
tenant_ref str
Tenant that this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str
Search FederationCheckpoint by uuid.
id String
name String
Search FederationCheckpoint by name.
tenantRef String
Tenant that this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Search FederationCheckpoint by uuid.

getFederationcheckpoint Result

The following output properties are available:

ConfigpbAttributes List<GetFederationcheckpointConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Date string
Date when the checkpoint was created. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string
Description for this checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
IsFederated string
This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string
Name of the checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
Tenant that this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Uuid of the checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []GetFederationcheckpointConfigpbAttribute
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Date string
Date when the checkpoint was created. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string
Description for this checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
IsFederated string
This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string
Name of the checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
Tenant that this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Uuid of the checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<GetFederationcheckpointConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
date String
Date when the checkpoint was created. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String
Description for this checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
isFederated String
This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String
Name of the checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
Tenant that this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Uuid of the checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes GetFederationcheckpointConfigpbAttribute[]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
date string
Date when the checkpoint was created. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description string
Description for this checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id string
isFederated string
This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name string
Name of the checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef string
Tenant that this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string
Uuid of the checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[GetFederationcheckpointConfigpbAttribute]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
date str
Date when the checkpoint was created. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description str
Description for this checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id str
is_federated str
This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name str
Name of the checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref str
Tenant that this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str
Uuid of the checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<Property Map>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
date String
Date when the checkpoint was created. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String
Description for this checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
isFederated String
This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String
Name of the checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
Tenant that this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Uuid of the checkpoint. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Supporting Types

GetFederationcheckpointConfigpbAttribute

Version This property is required. string
Version This property is required. string
version This property is required. String
version This property is required. string
version This property is required. str
version This property is required. String

Package Details

Repository
avi vmware/terraform-provider-avi
License
Notes
This Pulumi package is based on the avi Terraform Provider.