MongoDB Atlas v3.20.4, Oct 30 24

MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi

mongodbatlas.Provider

Explore with Pulumi AI

MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi

The provider type for the mongodbatlas package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create Provider Resource

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

Constructor syntax

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);

@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             assume_role: Optional[ProviderAssumeRoleArgs] = None,
             aws_access_key_id: Optional[str] = None,
             aws_secret_access_key: Optional[str] = None,
             aws_session_token: Optional[str] = None,
             base_url: Optional[str] = None,
             is_mongodbgov_cloud: Optional[bool] = None,
             private_key: Optional[str] = None,
             public_key: Optional[str] = None,
             realm_base_url: Optional[str] = None,
             region: Optional[str] = None,
             secret_name: Optional[str] = None,
             sts_endpoint: Optional[str] = None)

func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)

public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)

public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:mongodbatlas
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 ProviderArgs: 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 ProviderArgs: 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 ProviderArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

AssumeRole ProviderAssumeRole
AwsAccessKeyId string: AWS API Access Key.
AwsSecretAccessKey string: AWS API Access Secret Key.
AwsSessionToken string: AWS Security Token Service provided session token.
BaseUrl string: MongoDB Atlas Base URL
IsMongodbgovCloud bool: MongoDB Atlas Base URL default to gov
PrivateKey string: MongoDB Atlas Programmatic Private Key
PublicKey string: MongoDB Atlas Programmatic Public Key
RealmBaseUrl string: MongoDB Realm Base URL
Region string: Region where secret is stored as part of AWS Secret Manager.
SecretName string: Name of secret stored in AWS Secret Manager.
StsEndpoint string: AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.

AssumeRole ProviderAssumeRoleArgs
AwsAccessKeyId string: AWS API Access Key.
AwsSecretAccessKey string: AWS API Access Secret Key.
AwsSessionToken string: AWS Security Token Service provided session token.
BaseUrl string: MongoDB Atlas Base URL
IsMongodbgovCloud bool: MongoDB Atlas Base URL default to gov
PrivateKey string: MongoDB Atlas Programmatic Private Key
PublicKey string: MongoDB Atlas Programmatic Public Key
RealmBaseUrl string: MongoDB Realm Base URL
Region string: Region where secret is stored as part of AWS Secret Manager.
SecretName string: Name of secret stored in AWS Secret Manager.
StsEndpoint string: AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.

assumeRole ProviderAssumeRole
awsAccessKeyId String: AWS API Access Key.
awsSecretAccessKey String: AWS API Access Secret Key.
awsSessionToken String: AWS Security Token Service provided session token.
baseUrl String: MongoDB Atlas Base URL
isMongodbgovCloud Boolean: MongoDB Atlas Base URL default to gov
privateKey String: MongoDB Atlas Programmatic Private Key
publicKey String: MongoDB Atlas Programmatic Public Key
realmBaseUrl String: MongoDB Realm Base URL
region String: Region where secret is stored as part of AWS Secret Manager.
secretName String: Name of secret stored in AWS Secret Manager.
stsEndpoint String: AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.

assumeRole ProviderAssumeRole
awsAccessKeyId string: AWS API Access Key.
awsSecretAccessKey string: AWS API Access Secret Key.
awsSessionToken string: AWS Security Token Service provided session token.
baseUrl string: MongoDB Atlas Base URL
isMongodbgovCloud boolean: MongoDB Atlas Base URL default to gov
privateKey string: MongoDB Atlas Programmatic Private Key
publicKey string: MongoDB Atlas Programmatic Public Key
realmBaseUrl string: MongoDB Realm Base URL
region string: Region where secret is stored as part of AWS Secret Manager.
secretName string: Name of secret stored in AWS Secret Manager.
stsEndpoint string: AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.

assume_role ProviderAssumeRoleArgs
aws_access_key_id str: AWS API Access Key.
aws_secret_access_key str: AWS API Access Secret Key.
aws_session_token str: AWS Security Token Service provided session token.
base_url str: MongoDB Atlas Base URL
is_mongodbgov_cloud bool: MongoDB Atlas Base URL default to gov
private_key str: MongoDB Atlas Programmatic Private Key
public_key str: MongoDB Atlas Programmatic Public Key
realm_base_url str: MongoDB Realm Base URL
region str: Region where secret is stored as part of AWS Secret Manager.
secret_name str: Name of secret stored in AWS Secret Manager.
sts_endpoint str: AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.

assumeRole Property Map
awsAccessKeyId String: AWS API Access Key.
awsSecretAccessKey String: AWS API Access Secret Key.
awsSessionToken String: AWS Security Token Service provided session token.
baseUrl String: MongoDB Atlas Base URL
isMongodbgovCloud Boolean: MongoDB Atlas Base URL default to gov
privateKey String: MongoDB Atlas Programmatic Private Key
publicKey String: MongoDB Atlas Programmatic Public Key
realmBaseUrl String: MongoDB Realm Base URL
region String: Region where secret is stored as part of AWS Secret Manager.
secretName String: Name of secret stored in AWS Secret Manager.
stsEndpoint String: AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.

Outputs

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

Supporting Types

ProviderAssumeRole, ProviderAssumeRoleArgs

Duration string: The duration, between 15 minutes and 12 hours, of the role session. Valid time units are ns, us (or µs), ms, s, h, or m.
ExternalId string: A unique identifier that might be required when you assume a role in another account.
Policy string: IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.
PolicyArns List<string>: Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.
RoleArn string: Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
SessionName string: An identifier for the assumed role session.
SourceIdentity string: Source identity specified by the principal assuming the role.
Tags Dictionary<string, string>: Assume role session tags.
TransitiveTagKeys List<string>: Assume role session tag keys to pass to any subsequent sessions.

Duration string: The duration, between 15 minutes and 12 hours, of the role session. Valid time units are ns, us (or µs), ms, s, h, or m.
ExternalId string: A unique identifier that might be required when you assume a role in another account.
Policy string: IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.
PolicyArns []string: Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.
RoleArn string: Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
SessionName string: An identifier for the assumed role session.
SourceIdentity string: Source identity specified by the principal assuming the role.
Tags map[string]string: Assume role session tags.
TransitiveTagKeys []string: Assume role session tag keys to pass to any subsequent sessions.

duration String: The duration, between 15 minutes and 12 hours, of the role session. Valid time units are ns, us (or µs), ms, s, h, or m.
externalId String: A unique identifier that might be required when you assume a role in another account.
policy String: IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.
policyArns List<String>: Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.
roleArn String: Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
sessionName String: An identifier for the assumed role session.
sourceIdentity String: Source identity specified by the principal assuming the role.
tags Map<String,String>: Assume role session tags.
transitiveTagKeys List<String>: Assume role session tag keys to pass to any subsequent sessions.

duration string: The duration, between 15 minutes and 12 hours, of the role session. Valid time units are ns, us (or µs), ms, s, h, or m.
externalId string: A unique identifier that might be required when you assume a role in another account.
policy string: IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.
policyArns string[]: Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.
roleArn string: Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
sessionName string: An identifier for the assumed role session.
sourceIdentity string: Source identity specified by the principal assuming the role.
tags {[key: string]: string}: Assume role session tags.
transitiveTagKeys string[]: Assume role session tag keys to pass to any subsequent sessions.

duration str: The duration, between 15 minutes and 12 hours, of the role session. Valid time units are ns, us (or µs), ms, s, h, or m.
external_id str: A unique identifier that might be required when you assume a role in another account.
policy str: IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.
policy_arns Sequence[str]: Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.
role_arn str: Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
session_name str: An identifier for the assumed role session.
source_identity str: Source identity specified by the principal assuming the role.
tags Mapping[str, str]: Assume role session tags.
transitive_tag_keys Sequence[str]: Assume role session tag keys to pass to any subsequent sessions.

duration String: The duration, between 15 minutes and 12 hours, of the role session. Valid time units are ns, us (or µs), ms, s, h, or m.
externalId String: A unique identifier that might be required when you assume a role in another account.
policy String: IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.
policyArns List<String>: Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.
roleArn String: Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
sessionName String: An identifier for the assumed role session.
sourceIdentity String: Source identity specified by the principal assuming the role.
tags Map<String>: Assume role session tags.
transitiveTagKeys List<String>: Assume role session tag keys to pass to any subsequent sessions.

Package Details

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

MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi

pulumi/pulumi-mongodbatlas

mongodbatlas.Provider

On this page

On this page

Create Provider Resource

Constructor syntax

Parameters

Provider Resource Properties

Inputs

Outputs

Supporting Types

ProviderAssumeRole, ProviderAssumeRoleArgs

Package Details

On this page

On this page