New-AzSecurityAwsEnvironmentObject

  • Reference
Module:
Az.Security

Create an in-memory object for AwsEnvironment.

Syntax

New-AzSecurityAwsEnvironmentObject
   [-OrganizationalData <IAwsOrganizationalData>]
   [-Region <String[]>]
   [-ScanInterval <Int64>]
   [<CommonParameters>]

Description

Create an in-memory object for AwsEnvironment.

Examples

Example 1: Create new AwsEnvironment object as member

$member = New-AzSecurityAwsOrganizationalDataMemberObject -ParentHierarchyId "123"
New-AzSecurityAwsEnvironmentObject -Region "Central US" -ScanInterval 24 -OrganizationalData $member

AccountName        : 
EnvironmentType    : AwsAccount
OrganizationalData : {
                       "organizationMembershipType": "Member",
                       "parentHierarchyId": "123"
                     }
Region             : {Central US}
ScanInterval       : 24

Example 2: Create new AwsEnvironment object as organization

$organization = New-AzSecurityAwsOrganizationalDataMasterObject -StacksetName "myAwsStackSet" -ExcludedAccountId "123456789012"
New-AzSecurityAwsEnvironmentObject -Region "Central US" -ScanInterval 24 -OrganizationalData $organization

AccountName        : 
EnvironmentType    : AwsAccount
OrganizationalData : {
                       "organizationMembershipType": "Organization",
                       "stacksetName": "myAwsStackSet",
                       "excludedAccountIds": [ "123456789012" ]
                     }
Region             : {Central US}
ScanInterval       : 24

Parameters

-OrganizationalData

The AWS account's organizational data.

Type:IAwsOrganizationalData
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Region

list of regions to scan.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScanInterval

Scan interval in hours (value should be between 1-hour to 24-hours).

Type:Int64
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

AwsEnvironment