AWS SDK Version 3 for .NET
API 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.

Container for the parameters to the StartDeployment operation. Starts a deployment.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AppConfig.AmazonAppConfigRequest
      Amazon.AppConfig.Model.StartDeploymentRequest

Namespace: Amazon.AppConfig.Model
Assembly: AWSSDK.AppConfig.dll
Version: 3.x.y.z

Syntax

C#
public class StartDeploymentRequest : AmazonAppConfigRequest
         IAmazonWebServiceRequest

The StartDeploymentRequest type exposes the following members

Constructors

NameDescription
Public Method StartDeploymentRequest()

Properties

NameTypeDescription
Public Property ApplicationId System.String

Gets and sets the property ApplicationId.

The application ID.

Public Property ConfigurationProfileId System.String

Gets and sets the property ConfigurationProfileId.

The configuration profile ID.

Public Property ConfigurationVersion System.String

Gets and sets the property ConfigurationVersion.

The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.

Public Property DeploymentStrategyId System.String

Gets and sets the property DeploymentStrategyId.

The deployment strategy ID.

Public Property Description System.String

Gets and sets the property Description.

A description of the deployment.

Public Property DynamicExtensionParameters System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property DynamicExtensionParameters.

A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.

Public Property EnvironmentId System.String

Gets and sets the property EnvironmentId.

The environment ID.

Public Property KmsKeyIdentifier System.String

Gets and sets the property KmsKeyIdentifier.

The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Examples

The following start-deployment example starts a deployment to the application using the specified environment, deployment strategy, and configuration profile.

To start a configuration deployment


var client = new AmazonAppConfigClient();
var response = client.StartDeployment(new StartDeploymentRequest 
{
    ApplicationId = "339ohji",
    ConfigurationProfileId = "ur8hx2f",
    ConfigurationVersion = "1",
    DeploymentStrategyId = "1225qzk",
    Description = "",
    EnvironmentId = "54j1r29",
    Tags = new Dictionary<string, string> {
                    
    }
});

string applicationId = response.ApplicationId;
string configurationLocationUri = response.ConfigurationLocationUri;
string configurationName = response.ConfigurationName;
string configurationProfileId = response.ConfigurationProfileId;
string configurationVersion = response.ConfigurationVersion;
int deploymentDurationInMinutes = response.DeploymentDurationInMinutes;
int deploymentNumber = response.DeploymentNumber;
string deploymentStrategyId = response.DeploymentStrategyId;
string environmentId = response.EnvironmentId;
List<DeploymentEvent> eventLog = response.EventLog;
int finalBakeTimeInMinutes = response.FinalBakeTimeInMinutes;
float growthFactor = response.GrowthFactor;
string growthType = response.GrowthType;
float percentageComplete = response.PercentageComplete;
DateTime startedAt = response.StartedAt;
string state = response.State;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5