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:
- Project
Id string - The unique ID for the project. WARNING: Changing the
project_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource. - Role
Id string The unique ID of this role returned by the mongodb atlas api. WARNING: Changing the
role_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource.Conditional
- Aws
Cloud
Provider Access Authorization Aws - Azure
Cloud
Provider Access Authorization Azure
- Project
Id string - The unique ID for the project. WARNING: Changing the
project_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource. - Role
Id string The unique ID of this role returned by the mongodb atlas api. WARNING: Changing the
role_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource.Conditional
- Aws
Cloud
Provider Access Authorization Aws Args - Azure
Cloud
Provider Access Authorization Azure Args
- project
Id String - The unique ID for the project. WARNING: Changing the
project_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource. - role
Id String The unique ID of this role returned by the mongodb atlas api. WARNING: Changing the
role_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource.Conditional
- aws
Cloud
Provider Access Authorization Aws - azure
Cloud
Provider Access Authorization Azure
- project
Id string - The unique ID for the project. WARNING: Changing the
project_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource. - role
Id string The unique ID of this role returned by the mongodb atlas api. WARNING: Changing the
role_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource.Conditional
- aws
Cloud
Provider Access Authorization Aws - azure
Cloud
Provider Access Authorization Azure
- project_
id str - The unique ID for the project. WARNING: Changing the
project_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource. - role_
id str The unique ID of this role returned by the mongodb atlas api. WARNING: Changing the
role_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource.Conditional
- aws
Cloud
Provider Access Authorization Aws Args - azure
Cloud
Provider Access Authorization Azure Args
- project
Id String - The unique ID for the project. WARNING: Changing the
project_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource. - role
Id String The unique ID of this role returned by the mongodb atlas api. WARNING: Changing the
role_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource.Conditional
- aws Property Map
- azure Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the CloudProviderAccessAuthorization resource produces the following output properties:
- string
- Date on which this role was authorized.
- Feature
Usages List<CloudProvider Access Authorization Feature Usage> - Atlas features this AWS IAM role is linked to.
- Gcps
List<Cloud
Provider Access Authorization Gcp> - Id string
- The provider-assigned unique ID for this managed resource.
- string
- Date on which this role was authorized.
- Feature
Usages []CloudProvider Access Authorization Feature Usage - Atlas features this AWS IAM role is linked to.
- Gcps
[]Cloud
Provider Access Authorization Gcp - Id string
- The provider-assigned unique ID for this managed resource.
- String
- Date on which this role was authorized.
- feature
Usages List<CloudProvider Access Authorization Feature Usage> - Atlas features this AWS IAM role is linked to.
- gcps
List<Cloud
Provider Access Authorization Gcp> - id String
- The provider-assigned unique ID for this managed resource.
- string
- Date on which this role was authorized.
- feature
Usages CloudProvider Access Authorization Feature Usage[] - Atlas features this AWS IAM role is linked to.
- gcps
Cloud
Provider Access Authorization Gcp[] - id string
- The provider-assigned unique ID for this managed resource.
- str
- Date on which this role was authorized.
- feature_
usages Sequence[CloudProvider Access Authorization Feature Usage] - Atlas features this AWS IAM role is linked to.
- gcps
Sequence[Cloud
Provider Access Authorization Gcp] - id str
- The provider-assigned unique ID for this managed resource.
- String
- Date on which this role was authorized.
- feature
Usages List<Property Map> - Atlas features this AWS IAM role is linked to.
- gcps 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,
gcps: Optional[Sequence[CloudProviderAccessAuthorizationGcpArgs]] = None,
project_id: Optional[str] = None,
role_id: Optional[str] = None) -> CloudProviderAccessAuthorizationfunc 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)resources: _: type: mongodbatlas:CloudProviderAccessAuthorization get: id: ${id}- 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.
- string
- Date on which this role was authorized.
- Aws
Cloud
Provider Access Authorization Aws - Azure
Cloud
Provider Access Authorization Azure - Feature
Usages List<CloudProvider Access Authorization Feature Usage> - Atlas features this AWS IAM role is linked to.
- Gcps
List<Cloud
Provider Access Authorization Gcp> - Project
Id string - The unique ID for the project. WARNING: Changing the
project_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource. - Role
Id string The unique ID of this role returned by the mongodb atlas api. WARNING: Changing the
role_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource.Conditional
- string
- Date on which this role was authorized.
- Aws
Cloud
Provider Access Authorization Aws Args - Azure
Cloud
Provider Access Authorization Azure Args - Feature
Usages []CloudProvider Access Authorization Feature Usage Args - Atlas features this AWS IAM role is linked to.
- Gcps
[]Cloud
Provider Access Authorization Gcp Args - Project
Id string - The unique ID for the project. WARNING: Changing the
project_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource. - Role
Id string The unique ID of this role returned by the mongodb atlas api. WARNING: Changing the
role_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource.Conditional
- String
- Date on which this role was authorized.
- aws
Cloud
Provider Access Authorization Aws - azure
Cloud
Provider Access Authorization Azure - feature
Usages List<CloudProvider Access Authorization Feature Usage> - Atlas features this AWS IAM role is linked to.
- gcps
List<Cloud
Provider Access Authorization Gcp> - project
Id String - The unique ID for the project. WARNING: Changing the
project_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource. - role
Id String The unique ID of this role returned by the mongodb atlas api. WARNING: Changing the
role_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource.Conditional
- string
- Date on which this role was authorized.
- aws
Cloud
Provider Access Authorization Aws - azure
Cloud
Provider Access Authorization Azure - feature
Usages CloudProvider Access Authorization Feature Usage[] - Atlas features this AWS IAM role is linked to.
- gcps
Cloud
Provider Access Authorization Gcp[] - project
Id string - The unique ID for the project. WARNING: Changing the
project_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource. - role
Id string The unique ID of this role returned by the mongodb atlas api. WARNING: Changing the
role_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource.Conditional
- str
- Date on which this role was authorized.
- aws
Cloud
Provider Access Authorization Aws Args - azure
Cloud
Provider Access Authorization Azure Args - feature_
usages Sequence[CloudProvider Access Authorization Feature Usage Args] - Atlas features this AWS IAM role is linked to.
- gcps
Sequence[Cloud
Provider Access Authorization Gcp Args] - project_
id str - The unique ID for the project. WARNING: Changing the
project_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource. - role_
id str The unique ID of this role returned by the mongodb atlas api. WARNING: Changing the
role_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource.Conditional
- String
- Date on which this role was authorized.
- aws Property Map
- azure Property Map
- feature
Usages List<Property Map> - Atlas features this AWS IAM role is linked to.
- gcps List<Property Map>
- project
Id String - The unique ID for the project. WARNING: Changing the
project_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource. - role
Id String The unique ID of this role returned by the mongodb atlas api. WARNING: Changing the
role_idwill result in destruction of the existing authorization resource and the creation of a new authorization resource.Conditional
Supporting Types
CloudProviderAccessAuthorizationAws, CloudProviderAccessAuthorizationAwsArgs
- Iam
Assumed stringRole Arn - 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.
- Iam
Assumed stringRole Arn - 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.
- iam
Assumed StringRole Arn - 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.
- iam
Assumed stringRole Arn - 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.
- iam_
assumed_ strrole_ arn - 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.
- iam
Assumed StringRole Arn - 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.
CloudProviderAccessAuthorizationAzure, CloudProviderAccessAuthorizationAzureArgs
- Atlas
Azure stringApp Id - Azure Active Directory Application ID of Atlas.
- Service
Principal stringId - UUID string that identifies the Azure Service Principal.
- Tenant
Id string - UUID String that identifies the Azure Active Directory Tenant ID.
- Atlas
Azure stringApp Id - Azure Active Directory Application ID of Atlas.
- Service
Principal stringId - UUID string that identifies the Azure Service Principal.
- Tenant
Id string - UUID String that identifies the Azure Active Directory Tenant ID.
- atlas
Azure StringApp Id - Azure Active Directory Application ID of Atlas.
- service
Principal StringId - UUID string that identifies the Azure Service Principal.
- tenant
Id String - UUID String that identifies the Azure Active Directory Tenant ID.
- atlas
Azure stringApp Id - Azure Active Directory Application ID of Atlas.
- service
Principal stringId - UUID string that identifies the Azure Service Principal.
- tenant
Id string - UUID String that identifies the Azure Active Directory Tenant ID.
- atlas_
azure_ strapp_ id - Azure Active Directory Application ID of Atlas.
- service_
principal_ strid - UUID string that identifies the Azure Service Principal.
- tenant_
id str - UUID String that identifies the Azure Active Directory Tenant ID.
- atlas
Azure StringApp Id - Azure Active Directory Application ID of Atlas.
- service
Principal StringId - UUID string that identifies the Azure Service Principal.
- tenant
Id String - UUID String that identifies the Azure Active Directory Tenant ID.
CloudProviderAccessAuthorizationFeatureUsage, CloudProviderAccessAuthorizationFeatureUsageArgs
- Feature
Id Dictionary<string, string> - Feature
Type string
- Feature
Id map[string]string - Feature
Type string
- feature
Id Map<String,String> - feature
Type String
- feature
Id {[key: string]: string} - feature
Type string
- feature_
id Mapping[str, str] - feature_
type str
- feature
Id Map<String> - feature
Type String
CloudProviderAccessAuthorizationGcp, CloudProviderAccessAuthorizationGcpArgs
- Service
Account stringFor Atlas - Email address for the Google Service Account created by Atlas.
- Service
Account stringFor Atlas - Email address for the Google Service Account created by Atlas.
- service
Account StringFor Atlas - Email address for the Google Service Account created by Atlas.
- service
Account stringFor Atlas - Email address for the Google Service Account created by Atlas.
- service_
account_ strfor_ atlas - Email address for the Google Service Account created by Atlas.
- service
Account StringFor Atlas - Email address for the Google Service Account created by Atlas.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlasTerraform Provider.
