1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. CloudProviderAccessSetup
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

mongodbatlas.CloudProviderAccessSetup

Explore with Pulumi AI

Create CloudProviderAccessSetup Resource

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

Constructor syntax

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

@overload
def CloudProviderAccessSetup(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             project_id: Optional[str] = None,
                             provider_name: Optional[str] = None,
                             azure_configs: Optional[Sequence[CloudProviderAccessSetupAzureConfigArgs]] = None)
func NewCloudProviderAccessSetup(ctx *Context, name string, args CloudProviderAccessSetupArgs, opts ...ResourceOption) (*CloudProviderAccessSetup, error)
public CloudProviderAccessSetup(string name, CloudProviderAccessSetupArgs args, CustomResourceOptions? opts = null)
public CloudProviderAccessSetup(String name, CloudProviderAccessSetupArgs args)
public CloudProviderAccessSetup(String name, CloudProviderAccessSetupArgs args, CustomResourceOptions options)
type: mongodbatlas:CloudProviderAccessSetup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CloudProviderAccessSetupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CloudProviderAccessSetupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CloudProviderAccessSetupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CloudProviderAccessSetupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CloudProviderAccessSetupArgs
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 cloudProviderAccessSetupResource = new Mongodbatlas.CloudProviderAccessSetup("cloudProviderAccessSetupResource", new()
{
    ProjectId = "string",
    ProviderName = "string",
    AzureConfigs = new[]
    {
        new Mongodbatlas.Inputs.CloudProviderAccessSetupAzureConfigArgs
        {
            AtlasAzureAppId = "string",
            ServicePrincipalId = "string",
            TenantId = "string",
        },
    },
});
Copy
example, err := mongodbatlas.NewCloudProviderAccessSetup(ctx, "cloudProviderAccessSetupResource", &mongodbatlas.CloudProviderAccessSetupArgs{
	ProjectId:    pulumi.String("string"),
	ProviderName: pulumi.String("string"),
	AzureConfigs: mongodbatlas.CloudProviderAccessSetupAzureConfigArray{
		&mongodbatlas.CloudProviderAccessSetupAzureConfigArgs{
			AtlasAzureAppId:    pulumi.String("string"),
			ServicePrincipalId: pulumi.String("string"),
			TenantId:           pulumi.String("string"),
		},
	},
})
Copy
var cloudProviderAccessSetupResource = new CloudProviderAccessSetup("cloudProviderAccessSetupResource", CloudProviderAccessSetupArgs.builder()
    .projectId("string")
    .providerName("string")
    .azureConfigs(CloudProviderAccessSetupAzureConfigArgs.builder()
        .atlasAzureAppId("string")
        .servicePrincipalId("string")
        .tenantId("string")
        .build())
    .build());
Copy
cloud_provider_access_setup_resource = mongodbatlas.CloudProviderAccessSetup("cloudProviderAccessSetupResource",
    project_id="string",
    provider_name="string",
    azure_configs=[{
        "atlas_azure_app_id": "string",
        "service_principal_id": "string",
        "tenant_id": "string",
    }])
Copy
const cloudProviderAccessSetupResource = new mongodbatlas.CloudProviderAccessSetup("cloudProviderAccessSetupResource", {
    projectId: "string",
    providerName: "string",
    azureConfigs: [{
        atlasAzureAppId: "string",
        servicePrincipalId: "string",
        tenantId: "string",
    }],
});
Copy
type: mongodbatlas:CloudProviderAccessSetup
properties:
    azureConfigs:
        - atlasAzureAppId: string
          servicePrincipalId: string
          tenantId: string
    projectId: string
    providerName: string
Copy

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

ProjectId This property is required. string
ProviderName
This property is required.
Changes to this property will trigger replacement.
string
AzureConfigs List<CloudProviderAccessSetupAzureConfig>
ProjectId This property is required. string
ProviderName
This property is required.
Changes to this property will trigger replacement.
string
AzureConfigs []CloudProviderAccessSetupAzureConfigArgs
projectId This property is required. String
providerName
This property is required.
Changes to this property will trigger replacement.
String
azureConfigs List<CloudProviderAccessSetupAzureConfig>
projectId This property is required. string
providerName
This property is required.
Changes to this property will trigger replacement.
string
azureConfigs CloudProviderAccessSetupAzureConfig[]
project_id This property is required. str
provider_name
This property is required.
Changes to this property will trigger replacement.
str
azure_configs Sequence[CloudProviderAccessSetupAzureConfigArgs]
projectId This property is required. String
providerName
This property is required.
Changes to this property will trigger replacement.
String
azureConfigs List<Property Map>

Outputs

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

AwsConfigs List<CloudProviderAccessSetupAwsConfig>
CreatedDate string
Id string
The provider-assigned unique ID for this managed resource.
LastUpdatedDate string
RoleId string
AwsConfigs []CloudProviderAccessSetupAwsConfig
CreatedDate string
Id string
The provider-assigned unique ID for this managed resource.
LastUpdatedDate string
RoleId string
awsConfigs List<CloudProviderAccessSetupAwsConfig>
createdDate String
id String
The provider-assigned unique ID for this managed resource.
lastUpdatedDate String
roleId String
awsConfigs CloudProviderAccessSetupAwsConfig[]
createdDate string
id string
The provider-assigned unique ID for this managed resource.
lastUpdatedDate string
roleId string
aws_configs Sequence[CloudProviderAccessSetupAwsConfig]
created_date str
id str
The provider-assigned unique ID for this managed resource.
last_updated_date str
role_id str
awsConfigs List<Property Map>
createdDate String
id String
The provider-assigned unique ID for this managed resource.
lastUpdatedDate String
roleId String

Look up Existing CloudProviderAccessSetup Resource

Get an existing CloudProviderAccessSetup 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?: CloudProviderAccessSetupState, opts?: CustomResourceOptions): CloudProviderAccessSetup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_configs: Optional[Sequence[CloudProviderAccessSetupAwsConfigArgs]] = None,
        azure_configs: Optional[Sequence[CloudProviderAccessSetupAzureConfigArgs]] = None,
        created_date: Optional[str] = None,
        last_updated_date: Optional[str] = None,
        project_id: Optional[str] = None,
        provider_name: Optional[str] = None,
        role_id: Optional[str] = None) -> CloudProviderAccessSetup
func GetCloudProviderAccessSetup(ctx *Context, name string, id IDInput, state *CloudProviderAccessSetupState, opts ...ResourceOption) (*CloudProviderAccessSetup, error)
public static CloudProviderAccessSetup Get(string name, Input<string> id, CloudProviderAccessSetupState? state, CustomResourceOptions? opts = null)
public static CloudProviderAccessSetup get(String name, Output<String> id, CloudProviderAccessSetupState state, CustomResourceOptions options)
resources:  _:    type: mongodbatlas:CloudProviderAccessSetup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.

Supporting Types

CloudProviderAccessSetupAwsConfig
, CloudProviderAccessSetupAwsConfigArgs

CloudProviderAccessSetupAzureConfig
, CloudProviderAccessSetupAzureConfigArgs

AtlasAzureAppId This property is required. string
ServicePrincipalId This property is required. string
TenantId This property is required. string
AtlasAzureAppId This property is required. string
ServicePrincipalId This property is required. string
TenantId This property is required. string
atlasAzureAppId This property is required. String
servicePrincipalId This property is required. String
tenantId This property is required. String
atlasAzureAppId This property is required. string
servicePrincipalId This property is required. string
tenantId This property is required. string
atlas_azure_app_id This property is required. str
service_principal_id This property is required. str
tenant_id This property is required. str
atlasAzureAppId This property is required. String
servicePrincipalId This property is required. String
tenantId This property is required. String

Package Details

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