MongoDB Atlas

v3.5.1 published on Thursday, Sep 15, 2022 by Pulumi

CloudProviderAccess

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

Create a 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

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

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

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

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

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

Look up an 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

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

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

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

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

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.