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 Pinpoint Email CreateConfigurationSet API operation.

Syntax

New-PINEConfigurationSet
-ConfigurationSetName <String>
-TrackingOptions_CustomRedirectDomain <String>
-ReputationOptions_LastFreshStart <DateTime>
-ReputationOptions_ReputationMetricsEnabled <Boolean>
-SendingOptions_SendingEnabled <Boolean>
-DeliveryOptions_SendingPoolName <String>
-Tag <Tag[]>
-DeliveryOptions_TlsPolicy <TlsPolicy>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Parameters

-ConfigurationSetName <String>
The name of the configuration set.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-DeliveryOptions_SendingPoolName <String>
The name of the dedicated IP pool that you want to associate with the configuration set.
Required?False
Position?Named
Accept pipeline input?False
-DeliveryOptions_TlsPolicy <TlsPolicy>
Specifies whether Amazon Pinpoint should require that incoming email is delivered over a connection that’s encrypted by using Transport Layer Security (TLS). If this value is set to Require, Amazon Pinpoint will bounce email messages that cannot be delivered over TLS. The default value is Optional.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-PassThru <SwitchParameter>
Returns the value passed to the ConfigurationSetName parameter. By default, this cmdlet does not generate any output.
Required?False
Position?Named
Accept pipeline input?False
-ReputationOptions_LastFreshStart <DateTime>
The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.
Required?False
Position?Named
Accept pipeline input?False
-ReputationOptions_ReputationMetricsEnabled <Boolean>
If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
Required?False
Position?Named
Accept pipeline input?False
-SendingOptions_SendingEnabled <Boolean>
If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
Required?False
Position?Named
Accept pipeline input?False
-Tag <Tag[]>
An array of objects that define the tags (keys and values) that you want to associate with the configuration set.
Required?False
Position?Named
Accept pipeline input?False
AliasesTags
-TrackingOptions_CustomRedirectDomain <String>
The domain that you want to use for tracking open and click events.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

System.String
You can pipe a String object to this cmdlet for the ConfigurationSetName parameter.

Outputs

None or System.String
When you use the PassThru parameter, this cmdlet outputs the value supplied to the ConfigurationSetName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.PinpointEmail.Model.CreateConfigurationSetResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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