1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. CloudProviderAccessAuthorization
MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi

mongodbatlas.CloudProviderAccessAuthorization

Explore with Pulumi AI

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

    Create CloudProviderAccessAuthorization Resource

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

    Constructor syntax

    new CloudProviderAccessAuthorization(name: string, args: CloudProviderAccessAuthorizationArgs, opts?: CustomResourceOptions);
    @overload
    def CloudProviderAccessAuthorization(resource_name: str,
                                         args: CloudProviderAccessAuthorizationArgs,
                                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def CloudProviderAccessAuthorization(resource_name: str,
                                         opts: Optional[ResourceOptions] = None,
                                         project_id: Optional[str] = None,
                                         role_id: Optional[str] = None,
                                         aws: Optional[CloudProviderAccessAuthorizationAwsArgs] = None,
                                         azure: Optional[CloudProviderAccessAuthorizationAzureArgs] = None)
    func NewCloudProviderAccessAuthorization(ctx *Context, name string, args CloudProviderAccessAuthorizationArgs, opts ...ResourceOption) (*CloudProviderAccessAuthorization, error)
    public CloudProviderAccessAuthorization(string name, CloudProviderAccessAuthorizationArgs args, CustomResourceOptions? opts = null)
    public CloudProviderAccessAuthorization(String name, CloudProviderAccessAuthorizationArgs args)
    public CloudProviderAccessAuthorization(String name, CloudProviderAccessAuthorizationArgs args, CustomResourceOptions options)
    
    type: mongodbatlas:CloudProviderAccessAuthorization
    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 CloudProviderAccessAuthorizationArgs
    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 CloudProviderAccessAuthorizationArgs
    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 CloudProviderAccessAuthorizationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudProviderAccessAuthorizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudProviderAccessAuthorizationArgs
    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 cloudProviderAccessAuthorizationResource = new Mongodbatlas.CloudProviderAccessAuthorization("cloudProviderAccessAuthorizationResource", new()
    {
        ProjectId = "string",
        RoleId = "string",
        Aws = new Mongodbatlas.Inputs.CloudProviderAccessAuthorizationAwsArgs
        {
            IamAssumedRoleArn = "string",
        },
        Azure = new Mongodbatlas.Inputs.CloudProviderAccessAuthorizationAzureArgs
        {
            AtlasAzureAppId = "string",
            ServicePrincipalId = "string",
            TenantId = "string",
        },
    });
    
    example, err := mongodbatlas.NewCloudProviderAccessAuthorization(ctx, "cloudProviderAccessAuthorizationResource", &mongodbatlas.CloudProviderAccessAuthorizationArgs{
    	ProjectId: pulumi.String("string"),
    	RoleId:    pulumi.String("string"),
    	Aws: &mongodbatlas.CloudProviderAccessAuthorizationAwsArgs{
    		IamAssumedRoleArn: pulumi.String("string"),
    	},
    	Azure: &mongodbatlas.CloudProviderAccessAuthorizationAzureArgs{
    		AtlasAzureAppId:    pulumi.String("string"),
    		ServicePrincipalId: pulumi.String("string"),
    		TenantId:           pulumi.String("string"),
    	},
    })
    
    var cloudProviderAccessAuthorizationResource = new CloudProviderAccessAuthorization("cloudProviderAccessAuthorizationResource", CloudProviderAccessAuthorizationArgs.builder()
        .projectId("string")
        .roleId("string")
        .aws(CloudProviderAccessAuthorizationAwsArgs.builder()
            .iamAssumedRoleArn("string")
            .build())
        .azure(CloudProviderAccessAuthorizationAzureArgs.builder()
            .atlasAzureAppId("string")
            .servicePrincipalId("string")
            .tenantId("string")
            .build())
        .build());
    
    cloud_provider_access_authorization_resource = mongodbatlas.CloudProviderAccessAuthorization("cloudProviderAccessAuthorizationResource",
        project_id="string",
        role_id="string",
        aws={
            "iam_assumed_role_arn": "string",
        },
        azure={
            "atlas_azure_app_id": "string",
            "service_principal_id": "string",
            "tenant_id": "string",
        })
    
    const cloudProviderAccessAuthorizationResource = new mongodbatlas.CloudProviderAccessAuthorization("cloudProviderAccessAuthorizationResource", {
        projectId: "string",
        roleId: "string",
        aws: {
            iamAssumedRoleArn: "string",
        },
        azure: {
            atlasAzureAppId: "string",
            servicePrincipalId: "string",
            tenantId: "string",
        },
    });
    
    type: mongodbatlas:CloudProviderAccessAuthorization
    properties:
        aws:
            iamAssumedRoleArn: string
        azure:
            atlasAzureAppId: string
            servicePrincipalId: string
            tenantId: string
        projectId: string
        roleId: string
    

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

    Outputs

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

    AuthorizedDate string
    FeatureUsages List<CloudProviderAccessAuthorizationFeatureUsage>
    Id string
    The provider-assigned unique ID for this managed resource.
    AuthorizedDate string
    FeatureUsages []CloudProviderAccessAuthorizationFeatureUsage
    Id string
    The provider-assigned unique ID for this managed resource.
    authorizedDate String
    featureUsages List<CloudProviderAccessAuthorizationFeatureUsage>
    id String
    The provider-assigned unique ID for this managed resource.
    authorizedDate string
    featureUsages CloudProviderAccessAuthorizationFeatureUsage[]
    id string
    The provider-assigned unique ID for this managed resource.
    authorized_date str
    feature_usages Sequence[CloudProviderAccessAuthorizationFeatureUsage]
    id str
    The provider-assigned unique ID for this managed resource.
    authorizedDate String
    featureUsages List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CloudProviderAccessAuthorization Resource

    Get an existing CloudProviderAccessAuthorization 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?: CloudProviderAccessAuthorizationState, opts?: CustomResourceOptions): CloudProviderAccessAuthorization
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authorized_date: Optional[str] = None,
            aws: Optional[CloudProviderAccessAuthorizationAwsArgs] = None,
            azure: Optional[CloudProviderAccessAuthorizationAzureArgs] = None,
            feature_usages: Optional[Sequence[CloudProviderAccessAuthorizationFeatureUsageArgs]] = None,
            project_id: Optional[str] = None,
            role_id: Optional[str] = None) -> CloudProviderAccessAuthorization
    func GetCloudProviderAccessAuthorization(ctx *Context, name string, id IDInput, state *CloudProviderAccessAuthorizationState, opts ...ResourceOption) (*CloudProviderAccessAuthorization, error)
    public static CloudProviderAccessAuthorization Get(string name, Input<string> id, CloudProviderAccessAuthorizationState? state, CustomResourceOptions? opts = null)
    public static CloudProviderAccessAuthorization get(String name, Output<String> id, CloudProviderAccessAuthorizationState 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:

    Supporting Types

    CloudProviderAccessAuthorizationAws, CloudProviderAccessAuthorizationAwsArgs

    CloudProviderAccessAuthorizationAzure, CloudProviderAccessAuthorizationAzureArgs

    CloudProviderAccessAuthorizationFeatureUsage, CloudProviderAccessAuthorizationFeatureUsageArgs

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

    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.20.4 published on Wednesday, Oct 30, 2024 by Pulumi