Skip to content

Latest commit

 

History

History
 
 

cloud-connect-aws

README.md

Add-CsAwsSettings

Create or update Global Settings which are applied to all provisioned AWS accounts

References

Documentation, Swagger

Parameters

-Resources: An array of AWS settings

Example

PS> Add-CsAwsSettings -Resources @(@{ cloudtrail_bucket_owner_id = <string>; static_external_id = <string> })

Edit-CsAwsAccount

Update AWS accounts by specifying the ID of the group and details to update

References

Documentation, Swagger

Parameters

-Resources: An array of AWS account properties

Example

PS> Edit-CsAwsAccount -Resources @(@{ id = <string>; external_id = <string> })

Get-CsAwsAccess

Performs an access verification check on the specified AWS account IDs

References

Documentation, Swagger

Parameters

-Id: IDs of accounts to verify access on

Example

PS> Get-CsAwsAccess -Id @(<string>, <string>)

Get-CsAwsAccountId

Search for provisioned AWS Accounts

References

Documentation, Swagger

Parameters

-Filter: The filter expression that should be used to limit the results

-Limit: The maximum records to return [default: 500]

-Offset: The offset to start retrieving records from [default: 0]

-All: Repeat request until all results are returned

Example

PS> Get-CsAwsAccountId

Get-CsAwsAccountInfo

Retrieve a set of AWS Accounts by specifying their IDs

References

Documentation, Swagger

Parameters

-Id: IDs of accounts to retrieve details

-Filter: The filter expression that should be used to limit the results

-Limit: The maximum records to return [default: 500]

-Offset: The offset to start retrieving records from [default: 0]

-All: Repeat request until all results are returned

Example

PS> Get-CsAwsAccountInfo

Get-CsAwsSettings

Retrieve a set of Global Settings which are applicable to all provisioned AWS accounts

References

Swagger

Example

PS> Get-CsAwsSettings

New-CsAwsAccount

Provision AWS accounts by specifying details about the accounts to provision

References

Documentation, Swagger

Parameters

-Mode: Mode for provisioning. Allowed values are 'manual' or 'cloudformation' [default: manual]

-Resources: An array of AWS account properties

Example

PS> New-CsAwsAccount -Resources @(@{ iam_role_arn = <string>; external_id = <string> })

Remove-CsAwsAccount

Delete a set of AWS Accounts by specifying their IDs

References

Documentation, Swagger

Parameters

-Id: IDs of accounts to remove

Example

PS> Remove-CsAwsAccount -Id @(<string>, <string>)