Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. FederatedSettingsOrgConfig
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.FederatedSettingsOrgConfig

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    Create FederatedSettingsOrgConfig Resource

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

    Constructor syntax

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

@overload
def FederatedSettingsOrgConfig(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               domain_restriction_enabled: Optional[bool] = None,
                               federation_settings_id: Optional[str] = None,
                               identity_provider_id: Optional[str] = None,
                               org_id: Optional[str] = None,
                               domain_allow_lists: Optional[Sequence[str]] = None,
                               post_auth_role_grants: Optional[Sequence[str]] = None)
    func NewFederatedSettingsOrgConfig(ctx *Context, name string, args FederatedSettingsOrgConfigArgs, opts ...ResourceOption) (*FederatedSettingsOrgConfig, error)
    public FederatedSettingsOrgConfig(string name, FederatedSettingsOrgConfigArgs args, CustomResourceOptions? opts = null)
    public FederatedSettingsOrgConfig(String name, FederatedSettingsOrgConfigArgs args)
public FederatedSettingsOrgConfig(String name, FederatedSettingsOrgConfigArgs args, CustomResourceOptions options)

    type: mongodbatlas:FederatedSettingsOrgConfig
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 FederatedSettingsOrgConfigArgs
    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 FederatedSettingsOrgConfigArgs
    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 FederatedSettingsOrgConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FederatedSettingsOrgConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FederatedSettingsOrgConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var federatedSettingsOrgConfigResource = new Mongodbatlas.FederatedSettingsOrgConfig("federatedSettingsOrgConfigResource", new()
{
    DomainRestrictionEnabled = false,
    FederationSettingsId = "string",
    IdentityProviderId = "string",
    OrgId = "string",
    DomainAllowLists = new[]
    {
        "string",
    },
    PostAuthRoleGrants = new[]
    {
        "string",
    },
});

    example, err := mongodbatlas.NewFederatedSettingsOrgConfig(ctx, "federatedSettingsOrgConfigResource", &mongodbatlas.FederatedSettingsOrgConfigArgs{
	DomainRestrictionEnabled: pulumi.Bool(false),
	FederationSettingsId:     pulumi.String("string"),
	IdentityProviderId:       pulumi.String("string"),
	OrgId:                    pulumi.String("string"),
	DomainAllowLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	PostAuthRoleGrants: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var federatedSettingsOrgConfigResource = new FederatedSettingsOrgConfig("federatedSettingsOrgConfigResource", FederatedSettingsOrgConfigArgs.builder()        
    .domainRestrictionEnabled(false)
    .federationSettingsId("string")
    .identityProviderId("string")
    .orgId("string")
    .domainAllowLists("string")
    .postAuthRoleGrants("string")
    .build());

    federated_settings_org_config_resource = mongodbatlas.FederatedSettingsOrgConfig("federatedSettingsOrgConfigResource",
    domain_restriction_enabled=False,
    federation_settings_id="string",
    identity_provider_id="string",
    org_id="string",
    domain_allow_lists=["string"],
    post_auth_role_grants=["string"])

    const federatedSettingsOrgConfigResource = new mongodbatlas.FederatedSettingsOrgConfig("federatedSettingsOrgConfigResource", {
    domainRestrictionEnabled: false,
    federationSettingsId: "string",
    identityProviderId: "string",
    orgId: "string",
    domainAllowLists: ["string"],
    postAuthRoleGrants: ["string"],
});

    type: mongodbatlas:FederatedSettingsOrgConfig
properties:
    domainAllowLists:
        - string
    domainRestrictionEnabled: false
    federationSettingsId: string
    identityProviderId: string
    orgId: string
    postAuthRoleGrants:
        - string

    FederatedSettingsOrgConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The FederatedSettingsOrgConfig resource accepts the following input properties:

    Outputs

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

    Get an existing FederatedSettingsOrgConfig 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?: FederatedSettingsOrgConfigState, opts?: CustomResourceOptions): FederatedSettingsOrgConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        domain_allow_lists: Optional[Sequence[str]] = None,
        domain_restriction_enabled: Optional[bool] = None,
        federation_settings_id: Optional[str] = None,
        identity_provider_id: Optional[str] = None,
        org_id: Optional[str] = None,
        post_auth_role_grants: Optional[Sequence[str]] = None) -> FederatedSettingsOrgConfig
    func GetFederatedSettingsOrgConfig(ctx *Context, name string, id IDInput, state *FederatedSettingsOrgConfigState, opts ...ResourceOption) (*FederatedSettingsOrgConfig, error)
    public static FederatedSettingsOrgConfig Get(string name, Input<string> id, FederatedSettingsOrgConfigState? state, CustomResourceOptions? opts = null)
    public static FederatedSettingsOrgConfig get(String name, Output<String> id, FederatedSettingsOrgConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas