DeploySettings Class

Summary

The settings to use with downlad requests to Amazon CodeDeploy
Assembly
Cake.AWS.CodeDeploy.dll
Namespace
Cake.AWS.CodeDeploy
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["DeploySettings"] class Type type-node

Syntax

public class DeploySettings

Constructors

Name Summary
DeploySettings() Initializes a new instance of the DeploySettings class.

Properties

Name Value Summary
AccessKey string
The AWS Access Key ID
Region RegionEndpoint
The endpoints available to AWS clients.
S3Bucket string
The name of the Amazon S3 bucket where the application revision is stored.
S3Key string
The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
S3Version string
A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.
SecretKey string
The AWS Secret Access Key.
SessionToken string
The AWS Session Token, if using temporary credentials.

Extension Methods

Name Value Summary
Dump<DeploySettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DeploySettings>(DeploySettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DeploySettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<DeploySettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
SetAccessKey(string) DeploySettings
Specifies the AWS Access Key to use as credentials.
Requires the Cake.AWS.CodeDeploy addin
SetRegion(RegionEndpoint) DeploySettings
Specifies the endpoints available to AWS clients.
Requires the Cake.AWS.CodeDeploy addin
SetRegion(string) DeploySettings
Specifies the endpoints available to AWS clients.
Requires the Cake.AWS.CodeDeploy addin
SetSecretKey(string) DeploySettings
Specifies the AWS Secret Key to use as credentials.
Requires the Cake.AWS.CodeDeploy addin
SetSessionToken(string) DeploySettings
Specifies the AWS Session Token to use as credentials.
Requires the Cake.AWS.CodeDeploy addin
ThrowIfNull<DeploySettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<DeploySettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin