MongoDB Atlas v3.7.1, Mar 10 23

mongodbatlas.getFederatedSettings

mongodbatlas.getFederatedSettings provides a federated settings data source. Atlas Cloud federated settings provides federated settings outputs.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var settings = Mongodbatlas.GetFederatedSettings.Invoke(new()
    {
        OrgId = "627a9683e7f7f7ff7fe306f14",
    });

});

package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.GetFederatedSettings(ctx, &mongodbatlas.GetFederatedSettingsArgs{
			OrgId: "627a9683e7f7f7ff7fe306f14",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetFederatedSettingsArgs;
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 settings = MongodbatlasFunctions.getFederatedSettings(GetFederatedSettingsArgs.builder()
            .orgId("627a9683e7f7f7ff7fe306f14")
            .build());

    }
}

import pulumi
import pulumi_mongodbatlas as mongodbatlas

settings = mongodbatlas.get_federated_settings(org_id="627a9683e7f7f7ff7fe306f14")

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

const settings = mongodbatlas.getFederatedSettings({
    orgId: "627a9683e7f7f7ff7fe306f14",
});

variables:
  settings:
    fn::invoke:
      Function: mongodbatlas:getFederatedSettings
      Arguments:
        orgId: 627a9683e7f7f7ff7fe306f14

Using getFederatedSettings

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 getFederatedSettings(args: GetFederatedSettingsArgs, opts?: InvokeOptions): Promise<GetFederatedSettingsResult>
function getFederatedSettingsOutput(args: GetFederatedSettingsOutputArgs, opts?: InvokeOptions): Output<GetFederatedSettingsResult>

def get_federated_settings(org_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetFederatedSettingsResult
def get_federated_settings_output(org_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetFederatedSettingsResult]

func GetFederatedSettings(ctx *Context, args *GetFederatedSettingsArgs, opts ...InvokeOption) (*GetFederatedSettingsResult, error)
func GetFederatedSettingsOutput(ctx *Context, args *GetFederatedSettingsOutputArgs, opts ...InvokeOption) GetFederatedSettingsResultOutput

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

public static class GetFederatedSettings 
{
    public static Task<GetFederatedSettingsResult> InvokeAsync(GetFederatedSettingsArgs args, InvokeOptions? opts = null)
    public static Output<GetFederatedSettingsResult> Invoke(GetFederatedSettingsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFederatedSettingsResult> getFederatedSettings(GetFederatedSettingsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: mongodbatlas:index/getFederatedSettings:getFederatedSettings
  arguments:
    # arguments dictionary

The following arguments are supported:

OrgId string: Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

OrgId string: Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

orgId String: Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

orgId string: Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

org_id str: Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

orgId String: Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

getFederatedSettings Result

The following output properties are available:

FederatedDomains List<string>: List that contains the domains associated with the organization's identity provider.
HasRoleMappings bool: Flag that indicates whether this organization has role mappings configured.
Id string: Unique 24-hexadecimal digit string that identifies this federation.
IdentityProviderId string: Unique 20-hexadecimal digit string that identifies the identity provider connected to this organization.
IdentityProviderStatus string: Value that indicates whether the identity provider is active. Atlas returns ACTIVE if the identity provider is active and INACTIVE if the identity provider is inactive.
OrgId string

FederatedDomains []string: List that contains the domains associated with the organization's identity provider.
HasRoleMappings bool: Flag that indicates whether this organization has role mappings configured.
Id string: Unique 24-hexadecimal digit string that identifies this federation.
IdentityProviderId string: Unique 20-hexadecimal digit string that identifies the identity provider connected to this organization.
IdentityProviderStatus string: Value that indicates whether the identity provider is active. Atlas returns ACTIVE if the identity provider is active and INACTIVE if the identity provider is inactive.
OrgId string

federatedDomains List<String>: List that contains the domains associated with the organization's identity provider.
hasRoleMappings Boolean: Flag that indicates whether this organization has role mappings configured.
id String: Unique 24-hexadecimal digit string that identifies this federation.
identityProviderId String: Unique 20-hexadecimal digit string that identifies the identity provider connected to this organization.
identityProviderStatus String: Value that indicates whether the identity provider is active. Atlas returns ACTIVE if the identity provider is active and INACTIVE if the identity provider is inactive.
orgId String

federatedDomains string[]: List that contains the domains associated with the organization's identity provider.
hasRoleMappings boolean: Flag that indicates whether this organization has role mappings configured.
id string: Unique 24-hexadecimal digit string that identifies this federation.
identityProviderId string: Unique 20-hexadecimal digit string that identifies the identity provider connected to this organization.
identityProviderStatus string: Value that indicates whether the identity provider is active. Atlas returns ACTIVE if the identity provider is active and INACTIVE if the identity provider is inactive.
orgId string

federated_domains Sequence[str]: List that contains the domains associated with the organization's identity provider.
has_role_mappings bool: Flag that indicates whether this organization has role mappings configured.
id str: Unique 24-hexadecimal digit string that identifies this federation.
identity_provider_id str: Unique 20-hexadecimal digit string that identifies the identity provider connected to this organization.
identity_provider_status str: Value that indicates whether the identity provider is active. Atlas returns ACTIVE if the identity provider is active and INACTIVE if the identity provider is inactive.
org_id str

federatedDomains List<String>: List that contains the domains associated with the organization's identity provider.
hasRoleMappings Boolean: Flag that indicates whether this organization has role mappings configured.
id String: Unique 24-hexadecimal digit string that identifies this federation.
identityProviderId String: Unique 20-hexadecimal digit string that identifies the identity provider connected to this organization.
identityProviderStatus String: Value that indicates whether the identity provider is active. Atlas returns ACTIVE if the identity provider is active and INACTIVE if the identity provider is inactive.
orgId String

Package Details

Repository: MongoDB Atlas pulumi/pulumi-mongodbatlas
License: Apache-2.0
Notes: This Pulumi package is based on the mongodbatlas Terraform Provider.

mongodbatlas.getFederatedSettings

Example Usage

Using getFederatedSettings

getFederatedSettings Result

Package Details

Contents