1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. CloudProviderAccess
MongoDB Atlas v3.8.1 published on Tuesday, Jun 6, 2023 by Pulumi

mongodbatlas.CloudProviderAccess

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.8.1 published on Tuesday, Jun 6, 2023 by Pulumi

    Authorize role

    Once the resource is created add the field iam_assumed_role_arn see Set Up Unified AWS Access , and execute a new pulumi up this will create a PATCH request.

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const testRole = new mongodbatlas.CloudProviderAccess("testRole", {
        iamAssumedRoleArn: "arn:aws:iam::772401394250:role/test-user-role",
        projectId: "<PROJECT-ID>",
        providerName: "AWS",
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test_role = mongodbatlas.CloudProviderAccess("testRole",
        iam_assumed_role_arn="arn:aws:iam::772401394250:role/test-user-role",
        project_id="<PROJECT-ID>",
        provider_name="AWS")
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var testRole = new Mongodbatlas.CloudProviderAccess("testRole", new()
        {
            IamAssumedRoleArn = "arn:aws:iam::772401394250:role/test-user-role",
            ProjectId = "<PROJECT-ID>",
            ProviderName = "AWS",
        });
    
    });
    
    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.NewCloudProviderAccess(ctx, "testRole", &mongodbatlas.CloudProviderAccessArgs{
    			IamAssumedRoleArn: pulumi.String("arn:aws:iam::772401394250:role/test-user-role"),
    			ProjectId:         pulumi.String("<PROJECT-ID>"),
    			ProviderName:      pulumi.String("AWS"),
    		})
    		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.CloudProviderAccess;
    import com.pulumi.mongodbatlas.CloudProviderAccessArgs;
    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) {
            var testRole = new CloudProviderAccess("testRole", CloudProviderAccessArgs.builder()        
                .iamAssumedRoleArn("arn:aws:iam::772401394250:role/test-user-role")
                .projectId("<PROJECT-ID>")
                .providerName("AWS")
                .build());
    
        }
    }
    
    resources:
      testRole:
        type: mongodbatlas:CloudProviderAccess
        properties:
          iamAssumedRoleArn: arn:aws:iam::772401394250:role/test-user-role
          projectId: <PROJECT-ID>
          providerName: AWS
    

    mongodbatlas.CloudProviderAccess (optional)

    This is the first resource in the two-resource path as described above.

    mongodbatlas.CloudProviderAccessSetup Allows you to only register AWS IAM roles in Atlas.

    NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

    mongodbatlas_cloud_provider_authorization (optional)

    This is the second resource in the two-resource path as described above. mongodbatlas.CloudProviderAccessAuthorization Allows you to authorize an AWS IAM roles in Atlas.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var testRole = new Mongodbatlas.CloudProviderAccess("testRole", new()
        {
            ProjectId = "<PROJECT-ID>",
            ProviderName = "AWS",
        });
    
    });
    
    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.NewCloudProviderAccess(ctx, "testRole", &mongodbatlas.CloudProviderAccessArgs{
    			ProjectId:    pulumi.String("<PROJECT-ID>"),
    			ProviderName: pulumi.String("AWS"),
    		})
    		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.CloudProviderAccess;
    import com.pulumi.mongodbatlas.CloudProviderAccessArgs;
    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) {
            var testRole = new CloudProviderAccess("testRole", CloudProviderAccessArgs.builder()        
                .projectId("<PROJECT-ID>")
                .providerName("AWS")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test_role = mongodbatlas.CloudProviderAccess("testRole",
        project_id="<PROJECT-ID>",
        provider_name="AWS")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const testRole = new mongodbatlas.CloudProviderAccess("testRole", {
        projectId: "<PROJECT-ID>",
        providerName: "AWS",
    });
    
    resources:
      testRole:
        type: mongodbatlas:CloudProviderAccess
        properties:
          projectId: <PROJECT-ID>
          providerName: AWS
    

    Additional Examples

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var testRole = new Mongodbatlas.CloudProviderAccessSetup("testRole", new()
        {
            ProjectId = "<PROJECT-ID>",
            ProviderName = "AWS",
        });
    
    });
    
    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.NewCloudProviderAccessSetup(ctx, "testRole", &mongodbatlas.CloudProviderAccessSetupArgs{
    			ProjectId:    pulumi.String("<PROJECT-ID>"),
    			ProviderName: pulumi.String("AWS"),
    		})
    		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.CloudProviderAccessSetup;
    import com.pulumi.mongodbatlas.CloudProviderAccessSetupArgs;
    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) {
            var testRole = new CloudProviderAccessSetup("testRole", CloudProviderAccessSetupArgs.builder()        
                .projectId("<PROJECT-ID>")
                .providerName("AWS")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test_role = mongodbatlas.CloudProviderAccessSetup("testRole",
        project_id="<PROJECT-ID>",
        provider_name="AWS")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const testRole = new mongodbatlas.CloudProviderAccessSetup("testRole", {
        projectId: "<PROJECT-ID>",
        providerName: "AWS",
    });
    
    resources:
      testRole:
        type: mongodbatlas:CloudProviderAccessSetup
        properties:
          projectId: <PROJECT-ID>
          providerName: AWS
    

    Additional Examples

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var setupOnly = new Mongodbatlas.CloudProviderAccessSetup("setupOnly", new()
        {
            ProjectId = "<PROJECT-ID>",
            ProviderName = "AWS",
        });
    
        var authRole = new Mongodbatlas.CloudProviderAccessAuthorization("authRole", new()
        {
            ProjectId = setupOnly.ProjectId,
            RoleId = setupOnly.RoleId,
            Aws = new Mongodbatlas.Inputs.CloudProviderAccessAuthorizationAwsArgs
            {
                IamAssumedRoleArn = "arn:aws:iam::772401394250:role/test-user-role",
            },
        });
    
    });
    
    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 {
    		setupOnly, err := mongodbatlas.NewCloudProviderAccessSetup(ctx, "setupOnly", &mongodbatlas.CloudProviderAccessSetupArgs{
    			ProjectId:    pulumi.String("<PROJECT-ID>"),
    			ProviderName: pulumi.String("AWS"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = mongodbatlas.NewCloudProviderAccessAuthorization(ctx, "authRole", &mongodbatlas.CloudProviderAccessAuthorizationArgs{
    			ProjectId: setupOnly.ProjectId,
    			RoleId:    setupOnly.RoleId,
    			Aws: &mongodbatlas.CloudProviderAccessAuthorizationAwsArgs{
    				IamAssumedRoleArn: pulumi.String("arn:aws:iam::772401394250:role/test-user-role"),
    			},
    		})
    		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.CloudProviderAccessSetup;
    import com.pulumi.mongodbatlas.CloudProviderAccessSetupArgs;
    import com.pulumi.mongodbatlas.CloudProviderAccessAuthorization;
    import com.pulumi.mongodbatlas.CloudProviderAccessAuthorizationArgs;
    import com.pulumi.mongodbatlas.inputs.CloudProviderAccessAuthorizationAwsArgs;
    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) {
            var setupOnly = new CloudProviderAccessSetup("setupOnly", CloudProviderAccessSetupArgs.builder()        
                .projectId("<PROJECT-ID>")
                .providerName("AWS")
                .build());
    
            var authRole = new CloudProviderAccessAuthorization("authRole", CloudProviderAccessAuthorizationArgs.builder()        
                .projectId(setupOnly.projectId())
                .roleId(setupOnly.roleId())
                .aws(CloudProviderAccessAuthorizationAwsArgs.builder()
                    .iamAssumedRoleArn("arn:aws:iam::772401394250:role/test-user-role")
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    setup_only = mongodbatlas.CloudProviderAccessSetup("setupOnly",
        project_id="<PROJECT-ID>",
        provider_name="AWS")
    auth_role = mongodbatlas.CloudProviderAccessAuthorization("authRole",
        project_id=setup_only.project_id,
        role_id=setup_only.role_id,
        aws=mongodbatlas.CloudProviderAccessAuthorizationAwsArgs(
            iam_assumed_role_arn="arn:aws:iam::772401394250:role/test-user-role",
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const setupOnly = new mongodbatlas.CloudProviderAccessSetup("setupOnly", {
        projectId: "<PROJECT-ID>",
        providerName: "AWS",
    });
    const authRole = new mongodbatlas.CloudProviderAccessAuthorization("authRole", {
        projectId: setupOnly.projectId,
        roleId: setupOnly.roleId,
        aws: {
            iamAssumedRoleArn: "arn:aws:iam::772401394250:role/test-user-role",
        },
    });
    
    resources:
      setupOnly:
        type: mongodbatlas:CloudProviderAccessSetup
        properties:
          projectId: <PROJECT-ID>
          providerName: AWS
      authRole:
        type: mongodbatlas:CloudProviderAccessAuthorization
        properties:
          projectId: ${setupOnly.projectId}
          roleId: ${setupOnly.roleId}
          aws:
            iamAssumedRoleArn: arn:aws:iam::772401394250:role/test-user-role
    

    this will create a PATCH request.

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var testRole = new Mongodbatlas.CloudProviderAccess("testRole", new()
        {
            IamAssumedRoleArn = "arn:aws:iam::772401394250:role/test-user-role",
            ProjectId = "<PROJECT-ID>",
            ProviderName = "AWS",
        });
    
    });
    
    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.NewCloudProviderAccess(ctx, "testRole", &mongodbatlas.CloudProviderAccessArgs{
    			IamAssumedRoleArn: pulumi.String("arn:aws:iam::772401394250:role/test-user-role"),
    			ProjectId:         pulumi.String("<PROJECT-ID>"),
    			ProviderName:      pulumi.String("AWS"),
    		})
    		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.CloudProviderAccess;
    import com.pulumi.mongodbatlas.CloudProviderAccessArgs;
    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) {
            var testRole = new CloudProviderAccess("testRole", CloudProviderAccessArgs.builder()        
                .iamAssumedRoleArn("arn:aws:iam::772401394250:role/test-user-role")
                .projectId("<PROJECT-ID>")
                .providerName("AWS")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test_role = mongodbatlas.CloudProviderAccess("testRole",
        iam_assumed_role_arn="arn:aws:iam::772401394250:role/test-user-role",
        project_id="<PROJECT-ID>",
        provider_name="AWS")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const testRole = new mongodbatlas.CloudProviderAccess("testRole", {
        iamAssumedRoleArn: "arn:aws:iam::772401394250:role/test-user-role",
        projectId: "<PROJECT-ID>",
        providerName: "AWS",
    });
    
    resources:
      testRole:
        type: mongodbatlas:CloudProviderAccess
        properties:
          iamAssumedRoleArn: arn:aws:iam::772401394250:role/test-user-role
          projectId: <PROJECT-ID>
          providerName: AWS
    

    Create CloudProviderAccess Resource

    new CloudProviderAccess(name: string, args: CloudProviderAccessArgs, opts?: CustomResourceOptions);
    @overload
    def CloudProviderAccess(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            iam_assumed_role_arn: Optional[str] = None,
                            project_id: Optional[str] = None,
                            provider_name: Optional[str] = None)
    @overload
    def CloudProviderAccess(resource_name: str,
                            args: CloudProviderAccessArgs,
                            opts: Optional[ResourceOptions] = None)
    func NewCloudProviderAccess(ctx *Context, name string, args CloudProviderAccessArgs, opts ...ResourceOption) (*CloudProviderAccess, error)
    public CloudProviderAccess(string name, CloudProviderAccessArgs args, CustomResourceOptions? opts = null)
    public CloudProviderAccess(String name, CloudProviderAccessArgs args)
    public CloudProviderAccess(String name, CloudProviderAccessArgs args, CustomResourceOptions options)
    
    type: mongodbatlas:CloudProviderAccess
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args CloudProviderAccessArgs
    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 CloudProviderAccessArgs
    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 CloudProviderAccessArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudProviderAccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudProviderAccessArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ProjectId string

    The unique ID for the project

    ProviderName string

    The cloud provider for which to create a new role. Currently only AWS is supported.

    IamAssumedRoleArn string

    ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

    ProjectId string

    The unique ID for the project

    ProviderName string

    The cloud provider for which to create a new role. Currently only AWS is supported.

    IamAssumedRoleArn string

    ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

    projectId String

    The unique ID for the project

    providerName String

    The cloud provider for which to create a new role. Currently only AWS is supported.

    iamAssumedRoleArn String

    ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

    projectId string

    The unique ID for the project

    providerName string

    The cloud provider for which to create a new role. Currently only AWS is supported.

    iamAssumedRoleArn string

    ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

    project_id str

    The unique ID for the project

    provider_name str

    The cloud provider for which to create a new role. Currently only AWS is supported.

    iam_assumed_role_arn str

    ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

    projectId String

    The unique ID for the project

    providerName String

    The cloud provider for which to create a new role. Currently only AWS is supported.

    iamAssumedRoleArn String

    ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CloudProviderAccess resource produces the following output properties:

    AtlasAssumedRoleExternalId string

    Unique external ID Atlas uses when assuming the IAM role in your AWS account.

    AtlasAwsAccountArn string

    ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.

    AuthorizedDate string

    Date on which this role was authorized.

    CreatedDate string

    Date on which this role was created.

    FeatureUsages List<CloudProviderAccessFeatureUsage>

    Atlas features this AWS IAM role is linked to.

    Id string

    The provider-assigned unique ID for this managed resource.

    RoleId string

    Unique ID of this role returned by mongodb atlas api

    Conditional

    AtlasAssumedRoleExternalId string

    Unique external ID Atlas uses when assuming the IAM role in your AWS account.

    AtlasAwsAccountArn string

    ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.

    AuthorizedDate string

    Date on which this role was authorized.

    CreatedDate string

    Date on which this role was created.

    FeatureUsages []CloudProviderAccessFeatureUsage

    Atlas features this AWS IAM role is linked to.

    Id string

    The provider-assigned unique ID for this managed resource.

    RoleId string

    Unique ID of this role returned by mongodb atlas api

    Conditional

    atlasAssumedRoleExternalId String

    Unique external ID Atlas uses when assuming the IAM role in your AWS account.

    atlasAwsAccountArn String

    ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.

    authorizedDate String

    Date on which this role was authorized.

    createdDate String

    Date on which this role was created.

    featureUsages List<CloudProviderAccessFeatureUsage>

    Atlas features this AWS IAM role is linked to.

    id String

    The provider-assigned unique ID for this managed resource.

    roleId String

    Unique ID of this role returned by mongodb atlas api

    Conditional

    atlasAssumedRoleExternalId string

    Unique external ID Atlas uses when assuming the IAM role in your AWS account.

    atlasAwsAccountArn string

    ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.

    authorizedDate string

    Date on which this role was authorized.

    createdDate string

    Date on which this role was created.

    featureUsages CloudProviderAccessFeatureUsage[]

    Atlas features this AWS IAM role is linked to.

    id string

    The provider-assigned unique ID for this managed resource.

    roleId string

    Unique ID of this role returned by mongodb atlas api

    Conditional

    atlas_assumed_role_external_id str

    Unique external ID Atlas uses when assuming the IAM role in your AWS account.

    atlas_aws_account_arn str

    ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.

    authorized_date str

    Date on which this role was authorized.

    created_date str

    Date on which this role was created.

    feature_usages Sequence[CloudProviderAccessFeatureUsage]

    Atlas features this AWS IAM role is linked to.

    id str

    The provider-assigned unique ID for this managed resource.

    role_id str

    Unique ID of this role returned by mongodb atlas api

    Conditional

    atlasAssumedRoleExternalId String

    Unique external ID Atlas uses when assuming the IAM role in your AWS account.

    atlasAwsAccountArn String

    ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.

    authorizedDate String

    Date on which this role was authorized.

    createdDate String

    Date on which this role was created.

    featureUsages List<Property Map>

    Atlas features this AWS IAM role is linked to.

    id String

    The provider-assigned unique ID for this managed resource.

    roleId String

    Unique ID of this role returned by mongodb atlas api

    Conditional

    Look up Existing CloudProviderAccess Resource

    Get an existing CloudProviderAccess 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?: CloudProviderAccessState, opts?: CustomResourceOptions): CloudProviderAccess
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            atlas_assumed_role_external_id: Optional[str] = None,
            atlas_aws_account_arn: Optional[str] = None,
            authorized_date: Optional[str] = None,
            created_date: Optional[str] = None,
            feature_usages: Optional[Sequence[CloudProviderAccessFeatureUsageArgs]] = None,
            iam_assumed_role_arn: Optional[str] = None,
            project_id: Optional[str] = None,
            provider_name: Optional[str] = None,
            role_id: Optional[str] = None) -> CloudProviderAccess
    func GetCloudProviderAccess(ctx *Context, name string, id IDInput, state *CloudProviderAccessState, opts ...ResourceOption) (*CloudProviderAccess, error)
    public static CloudProviderAccess Get(string name, Input<string> id, CloudProviderAccessState? state, CustomResourceOptions? opts = null)
    public static CloudProviderAccess get(String name, Output<String> id, CloudProviderAccessState 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:
    AtlasAssumedRoleExternalId string

    Unique external ID Atlas uses when assuming the IAM role in your AWS account.

    AtlasAwsAccountArn string

    ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.

    AuthorizedDate string

    Date on which this role was authorized.

    CreatedDate string

    Date on which this role was created.

    FeatureUsages List<CloudProviderAccessFeatureUsageArgs>

    Atlas features this AWS IAM role is linked to.

    IamAssumedRoleArn string

    ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

    ProjectId string

    The unique ID for the project

    ProviderName string

    The cloud provider for which to create a new role. Currently only AWS is supported.

    RoleId string

    Unique ID of this role returned by mongodb atlas api

    Conditional

    AtlasAssumedRoleExternalId string

    Unique external ID Atlas uses when assuming the IAM role in your AWS account.

    AtlasAwsAccountArn string

    ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.

    AuthorizedDate string

    Date on which this role was authorized.

    CreatedDate string

    Date on which this role was created.

    FeatureUsages []CloudProviderAccessFeatureUsageArgs

    Atlas features this AWS IAM role is linked to.

    IamAssumedRoleArn string

    ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

    ProjectId string

    The unique ID for the project

    ProviderName string

    The cloud provider for which to create a new role. Currently only AWS is supported.

    RoleId string

    Unique ID of this role returned by mongodb atlas api

    Conditional

    atlasAssumedRoleExternalId String

    Unique external ID Atlas uses when assuming the IAM role in your AWS account.

    atlasAwsAccountArn String

    ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.

    authorizedDate String

    Date on which this role was authorized.

    createdDate String

    Date on which this role was created.

    featureUsages List<CloudProviderAccessFeatureUsageArgs>

    Atlas features this AWS IAM role is linked to.

    iamAssumedRoleArn String

    ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

    projectId String

    The unique ID for the project

    providerName String

    The cloud provider for which to create a new role. Currently only AWS is supported.

    roleId String

    Unique ID of this role returned by mongodb atlas api

    Conditional

    atlasAssumedRoleExternalId string

    Unique external ID Atlas uses when assuming the IAM role in your AWS account.

    atlasAwsAccountArn string

    ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.

    authorizedDate string

    Date on which this role was authorized.

    createdDate string

    Date on which this role was created.

    featureUsages CloudProviderAccessFeatureUsageArgs[]

    Atlas features this AWS IAM role is linked to.

    iamAssumedRoleArn string

    ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

    projectId string

    The unique ID for the project

    providerName string

    The cloud provider for which to create a new role. Currently only AWS is supported.

    roleId string

    Unique ID of this role returned by mongodb atlas api

    Conditional

    atlas_assumed_role_external_id str

    Unique external ID Atlas uses when assuming the IAM role in your AWS account.

    atlas_aws_account_arn str

    ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.

    authorized_date str

    Date on which this role was authorized.

    created_date str

    Date on which this role was created.

    feature_usages Sequence[CloudProviderAccessFeatureUsageArgs]

    Atlas features this AWS IAM role is linked to.

    iam_assumed_role_arn str

    ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

    project_id str

    The unique ID for the project

    provider_name str

    The cloud provider for which to create a new role. Currently only AWS is supported.

    role_id str

    Unique ID of this role returned by mongodb atlas api

    Conditional

    atlasAssumedRoleExternalId String

    Unique external ID Atlas uses when assuming the IAM role in your AWS account.

    atlasAwsAccountArn String

    ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.

    authorizedDate String

    Date on which this role was authorized.

    createdDate String

    Date on which this role was created.

    featureUsages List<Property Map>

    Atlas features this AWS IAM role is linked to.

    iamAssumedRoleArn String

    ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

    projectId String

    The unique ID for the project

    providerName String

    The cloud provider for which to create a new role. Currently only AWS is supported.

    roleId String

    Unique ID of this role returned by mongodb atlas api

    Conditional

    Supporting Types

    CloudProviderAccessFeatureUsage

    FeatureId Dictionary<string, object>
    FeatureType string
    FeatureId map[string]interface{}
    FeatureType string
    featureId Map<String,Object>
    featureType String
    featureId {[key: string]: any}
    featureType string
    feature_id Mapping[str, Any]
    feature_type str
    featureId Map<Any>
    featureType String

    Import

    The Cloud Provider Access resource can be imported using project ID and the provider name and mongodbatlas role id, in the format project_id-provider_name-role_id, e.g.

     $ pulumi import mongodbatlas:index/cloudProviderAccess:CloudProviderAccess my_role 1112222b3bf99403840e8934-AWS-5fc17d476f7a33224f5b224e
    

    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.8.1 published on Tuesday, Jun 6, 2023 by Pulumi