AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Elastic Compute Cloud (EC2) CreateMacSystemIntegrityProtectionModificationTask API operation.

Syntax

New-EC2MacSystemIntegrityProtectionModificationTask
-InstanceId <String>
-MacSystemIntegrityProtectionConfiguration_AppleInternal <MacSystemIntegrityProtectionSettingStatus>
-MacSystemIntegrityProtectionConfiguration_BaseSystem <MacSystemIntegrityProtectionSettingStatus>
-MacSystemIntegrityProtectionConfiguration_DebuggingRestriction <MacSystemIntegrityProtectionSettingStatus>
-MacSystemIntegrityProtectionConfiguration_DTraceRestriction <MacSystemIntegrityProtectionSettingStatus>
-MacSystemIntegrityProtectionConfiguration_FilesystemProtection <MacSystemIntegrityProtectionSettingStatus>
-MacSystemIntegrityProtectionConfiguration_KextSigning <MacSystemIntegrityProtectionSettingStatus>
-MacCredential <String>
-MacSystemIntegrityProtectionStatus <MacSystemIntegrityProtectionSettingStatus>
-MacSystemIntegrityProtectionConfiguration_NvramProtection <MacSystemIntegrityProtectionSettingStatus>
-TagSpecification <TagSpecification[]>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonEC2Config>

Description

Creates a System Integrity Protection (SIP) modification task to configure the SIP settings for an x86 Mac instance or Apple silicon Mac instance. For more information, see Configure SIP for Amazon EC2 instances in the Amazon EC2 User Guide. When you configure the SIP settings for your instance, you can either enable or disable all SIP settings, or you can specify a custom SIP configuration that selectively enables or disables specific SIP settings. If you implement a custom configuration, connect to the instance and verify the settings to ensure that your requirements are properly implemented and functioning as intended. SIP configurations might change with macOS updates. We recommend that you review custom SIP settings after any macOS version upgrade to ensure continued compatibility and proper functionality of your security configurations. To enable or disable all SIP settings, use the MacSystemIntegrityProtectionStatus parameter only. For example, to enable all SIP settings, specify the following:
  • MacSystemIntegrityProtectionStatus=enabled
To specify a custom configuration that selectively enables or disables specific SIP settings, use the MacSystemIntegrityProtectionStatus parameter to enable or disable all SIP settings, and then use the MacSystemIntegrityProtectionConfiguration parameter to specify exceptions. In this case, the exceptions you specify for MacSystemIntegrityProtectionConfiguration override the value you specify for MacSystemIntegrityProtectionStatus. For example, to enable all SIP settings, except NvramProtections, specify the following:
  • MacSystemIntegrityProtectionStatus=enabled
  • MacSystemIntegrityProtectionConfigurationRequest "NvramProtections=disabled"

Parameters

-ClientConfig <AmazonEC2Config>
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceId <String>
The ID of the Amazon EC2 Mac instance.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-MacCredential <String>
[Apple silicon Mac instances only] Specifies the following credentials:
  • Internal disk administrative user
    • Username - Only the default administrative user (aws-managed-user) is supported and it is used by default. You can't specify a different administrative user.
    • Password - If you did not change the default password for aws-managed-user, specify the default password, which is blank. Otherwise, specify your password.
  • Amazon EBS root volume administrative user
    • Username - If you did not change the default administrative user, specify ec2-user. Otherwise, specify the username for your administrative user.
    • Password - Specify the password for the administrative user.
The credentials must be specified in the following JSON format:{ "internalDiskPassword":"internal-disk-admin_password", "rootVolumeUsername":"root-volume-admin_username", "rootVolumepassword":"root-volume-admin_password" }
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMacCredentials
-MacSystemIntegrityProtectionConfiguration_AppleInternal <MacSystemIntegrityProtectionSettingStatus>
Enables or disables Apple Internal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MacSystemIntegrityProtectionConfiguration_BaseSystem <MacSystemIntegrityProtectionSettingStatus>
Enables or disables Base System.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MacSystemIntegrityProtectionConfiguration_DebuggingRestriction <MacSystemIntegrityProtectionSettingStatus>
Enables or disables Debugging Restrictions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMacSystemIntegrityProtectionConfiguration_DebuggingRestrictions
-MacSystemIntegrityProtectionConfiguration_DTraceRestriction <MacSystemIntegrityProtectionSettingStatus>
Enables or disables Dtrace Restrictions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMacSystemIntegrityProtectionConfiguration_DTraceRestrictions
-MacSystemIntegrityProtectionConfiguration_FilesystemProtection <MacSystemIntegrityProtectionSettingStatus>
Enables or disables Filesystem Protections.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMacSystemIntegrityProtectionConfiguration_FilesystemProtections
-MacSystemIntegrityProtectionConfiguration_KextSigning <MacSystemIntegrityProtectionSettingStatus>
Enables or disables Kext Signing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MacSystemIntegrityProtectionConfiguration_NvramProtection <MacSystemIntegrityProtectionSettingStatus>
Enables or disables Nvram Protections.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMacSystemIntegrityProtectionConfiguration_NvramProtections
-MacSystemIntegrityProtectionStatus <MacSystemIntegrityProtectionSettingStatus>
Specifies the overall SIP status for the instance. To enable all SIP settings, specify enabled. To disable all SIP settings, specify disabled.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'MacModificationTask'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.CreateMacSystemIntegrityProtectionModificationTaskResponse). Specifying the name of a property of type Amazon.EC2.Model.CreateMacSystemIntegrityProtectionModificationTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TagSpecification <TagSpecification[]>
Specifies tags to apply to the SIP modification task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTagSpecifications

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.EC2.Model.MacModificationTask or Amazon.EC2.Model.CreateMacSystemIntegrityProtectionModificationTaskResponse
This cmdlet returns an Amazon.EC2.Model.MacModificationTask object. The service call response (type Amazon.EC2.Model.CreateMacSystemIntegrityProtectionModificationTaskResponse) can be returned by specifying '-Select *'.
User Guide
Service API Reference
Microsoft Windows Guide
VPC User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z