Skip to content

README.md

Latest commit

 

History

History
145 lines (84 loc) · 5.04 KB

README.md

File metadata and controls

145 lines (84 loc) · 5.04 KB

MongoDB::Atlas::FederatedDatabaseInstance

Returns, adds, edits, and removes Federated Database Instances.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
    "Type" : "MongoDB::Atlas::FederatedDatabaseInstance",
    "Properties" : {
        "CloudProviderConfig" : CloudProviderConfig,
        "DataProcessRegion" : DataProcessRegion,
        "ProjectId" : String,
        "TenantName" : String,
        "SkipRoleValidation" : Boolean,
        "Storage" : Storage,
        "Profile" : String
    }
}

YAML

Type: MongoDB::Atlas::FederatedDatabaseInstance
Properties:
    CloudProviderConfig: CloudProviderConfig
    DataProcessRegion: DataProcessRegion
    ProjectId: String
    TenantName: String
    SkipRoleValidation: Boolean
    Storage: Storage
    Profile: String

Properties

CloudProviderConfig

Cloud provider linked to this Atlas Data Federation.

Required: No

Type: CloudProviderConfig

Update requires: No interruption

DataProcessRegion

Information about the cloud provider region to which the Atlas Data Federation routes client connections. MongoDB Cloud supports AWS only.

Required: No

Type: DataProcessRegion

Update requires: No interruption

ProjectId

Unique 24-hexadecimal digit string that identifies your project.

Required: Yes

Type: String

Minimum Length: 24

Maximum Length: 24

Pattern: ^([a-f0-9]{24})$

Update requires: Replacement

TenantName

Human-readable label that identifies the data federation.

Required: Yes

Type: String

Update requires: Replacement

SkipRoleValidation

Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.

Required: No

Type: Boolean

Update requires: No interruption

Storage

Configuration information for each data store and its mapping to MongoDB Cloud databases.

Required: No

Type: Storage

Update requires: No interruption

Profile

The profile is defined in AWS Secret manager. See Secret Manager Profile setup.

Required: No

Type: String

Update requires: Replacement

Return Values

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ExternalId

Returns the ExternalId value.

IamAssumedRoleARN

Returns the IamAssumedRoleARN value.

IamUserARN

Returns the IamUserARN value.

HostNames

Type of Federated Database Instances to return.

State

Type of Federated Database Instances to return.