Class CfnConfigurationManager.ConfigurationDefinitionProperty

The definition of a Quick Setup configuration.

Inheritance

object

CfnConfigurationManager.ConfigurationDefinitionProperty

Implements

CfnConfigurationManager.IConfigurationDefinitionProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.SSMQuickSetup

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnConfigurationManager.ConfigurationDefinitionProperty : CfnConfigurationManager.IConfigurationDefinitionProperty

Syntax (vb)

Public Class CfnConfigurationManager.ConfigurationDefinitionProperty Implements CfnConfigurationManager.IConfigurationDefinitionProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.SSMQuickSetup;

             var configurationDefinitionProperty = new ConfigurationDefinitionProperty {
                 Parameters = new Dictionary<string, string> {
                     { "parametersKey", "parameters" }
                 },
                 Type = "type",

                 // the properties below are optional
                 Id = "id",
                 LocalDeploymentAdministrationRoleArn = "localDeploymentAdministrationRoleArn",
                 LocalDeploymentExecutionRoleName = "localDeploymentExecutionRoleName",
                 TypeVersion = "typeVersion"
             };

Synopsis

Constructors

ConfigurationDefinitionProperty()

The definition of a Quick Setup configuration.

Properties

Id	The ID of the configuration definition.
LocalDeploymentAdministrationRoleArn	The ARN of the IAM role used to administrate local configuration deployments.
LocalDeploymentExecutionRoleName	The name of the IAM role used to deploy local configurations.
Parameters	The parameters for the configuration definition type.
Type	The type of the Quick Setup configuration.
TypeVersion	The version of the Quick Setup type used.

Constructors

ConfigurationDefinitionProperty()

The definition of a Quick Setup configuration.

public ConfigurationDefinitionProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.SSMQuickSetup;

             var configurationDefinitionProperty = new ConfigurationDefinitionProperty {
                 Parameters = new Dictionary<string, string> {
                     { "parametersKey", "parameters" }
                 },
                 Type = "type",

                 // the properties below are optional
                 Id = "id",
                 LocalDeploymentAdministrationRoleArn = "localDeploymentAdministrationRoleArn",
                 LocalDeploymentExecutionRoleName = "localDeploymentExecutionRoleName",
                 TypeVersion = "typeVersion"
             };

Properties

Id

The ID of the configuration definition.

public string? Id { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html#cfn-ssmquicksetup-configurationmanager-configurationdefinition-id

LocalDeploymentAdministrationRoleArn

The ARN of the IAM role used to administrate local configuration deployments.

public string? LocalDeploymentAdministrationRoleArn { get; set; }

Property Value

string

Remarks

Although this element is listed as "Required: No", a value can be omitted only for organizational deployments of types other than <code>AWSQuickSetupType-PatchPolicy</code> . A value must be provided when you are running an organizational deployment for a patch policy or running any type of deployment for a single account.

LocalDeploymentExecutionRoleName

The name of the IAM role used to deploy local configurations.

public string? LocalDeploymentExecutionRoleName { get; set; }

Property Value

string

Remarks

Although this element is listed as "Required: No", a value can be omitted only for organizational deployments of types other than <code>AWSQuickSetupType-PatchPolicy</code> . A value must be provided when you are running an organizational deployment for a patch policy or running any type of deployment for a single account.

Parameters

The parameters for the configuration definition type.

public object Parameters { get; set; }

Property Value

object

Remarks

Parameters for configuration definitions vary based the configuration type. The following lists outline the parameters for each configuration type.

Type union: either Dictionary<string, string> or IResolvable

Type

The type of the Quick Setup configuration.

public string Type { get; set; }

Property Value

string

Remarks

TypeVersion

The version of the Quick Setup type used.

public string? TypeVersion { get; set; }