Edit

Share via

New-AzSecurityAwsEnvironmentObject

Module:
Az.Security Module

Create an in-memory object for AwsEnvironment.

Syntax

Default (Default) 

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.

Parameter properties

Type:IAwsOrganizationalData
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Region

list of regions to scan.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ScanInterval

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

Parameter properties

Type:Int64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

AwsEnvironment