Interface ICfnStackProps
Properties for defining a CfnStack.
Namespace: Amazon.CDK.AWS.OpsWorks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnStackPropsSyntax (vb)
Public Interface ICfnStackPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.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.OpsWorks;
var customJson;
var cfnStackProps = new CfnStackProps {
DefaultInstanceProfileArn = "defaultInstanceProfileArn",
Name = "name",
ServiceRoleArn = "serviceRoleArn",
// the properties below are optional
AgentVersion = "agentVersion",
Attributes = new Dictionary<string, string> {
{ "attributesKey", "attributes" }
},
ChefConfiguration = new ChefConfigurationProperty {
BerkshelfVersion = "berkshelfVersion",
ManageBerkshelf = false
},
CloneAppIds = new [] { "cloneAppIds" },
ClonePermissions = false,
ConfigurationManager = new StackConfigurationManagerProperty {
Name = "name",
Version = "version"
},
CustomCookbooksSource = new SourceProperty {
Password = "password",
Revision = "revision",
SshKey = "sshKey",
Type = "type",
Url = "url",
Username = "username"
},
CustomJson = customJson,
DefaultAvailabilityZone = "defaultAvailabilityZone",
DefaultOs = "defaultOs",
DefaultRootDeviceType = "defaultRootDeviceType",
DefaultSshKeyName = "defaultSshKeyName",
DefaultSubnetId = "defaultSubnetId",
EcsClusterArn = "ecsClusterArn",
ElasticIps = new [] { new ElasticIpProperty {
Ip = "ip",
// the properties below are optional
Name = "name"
} },
HostnameTheme = "hostnameTheme",
RdsDbInstances = new [] { new RdsDbInstanceProperty {
DbPassword = "dbPassword",
DbUser = "dbUser",
RdsDbInstanceArn = "rdsDbInstanceArn"
} },
SourceStackId = "sourceStackId",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UseCustomCookbooks = false,
UseOpsworksSecurityGroups = false,
VpcId = "vpcId"
};Synopsis
Properties
| AgentVersion | The default AWS OpsWorks Stacks agent version. You have the following options:. |
| Attributes | One or more user-defined key-value pairs to be added to the stack attributes. |
| ChefConfiguration | A |
| CloneAppIds | If you're cloning an AWS OpsWorks stack, a list of AWS OpsWorks application stack IDs from the source stack to include in the cloned stack. |
| ClonePermissions | If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions. |
| ConfigurationManager | The configuration manager. |
| CustomCookbooksSource | Contains the information required to retrieve an app or cookbook from a repository. |
| CustomJson | A string that contains user-defined, custom JSON. |
| DefaultAvailabilityZone | The stack's default Availability Zone, which must be in the specified region. |
| DefaultInstanceProfileArn | The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. |
| DefaultOs | The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. |
| DefaultRootDeviceType | The default root device type. |
| DefaultSshKeyName | A default Amazon EC2 key pair name. |
| DefaultSubnetId | The stack's default subnet ID. |
| EcsClusterArn | The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the AWS OpsWorks stack. |
| ElasticIps | A list of Elastic IP addresses to register with the AWS OpsWorks stack. |
| HostnameTheme | The stack's host name theme, with spaces replaced by underscores. |
| Name | The stack name. |
| RdsDbInstances | The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the AWS OpsWorks stack. |
| ServiceRoleArn | The stack's IAM role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. |
| SourceStackId | If you're cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone. |
| Tags | A map that contains tag keys and tag values that are attached to a stack or layer. |
| UseCustomCookbooks | Whether the stack uses custom cookbooks. |
| UseOpsworksSecurityGroups | Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers. |
| VpcId | The ID of the VPC that the stack is to be launched into. |
Properties
AgentVersion
The default AWS OpsWorks Stacks agent version. You have the following options:.
string? AgentVersion { get; }Property Value
Remarks
The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions . AgentVersion cannot be set to Chef 12.2.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
Attributes
One or more user-defined key-value pairs to be added to the stack attributes.
object? Attributes { get; }Property Value
Remarks
ChefConfiguration
A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack .
object? ChefConfiguration { get; }Property Value
Remarks
CloneAppIds
If you're cloning an AWS OpsWorks stack, a list of AWS OpsWorks application stack IDs from the source stack to include in the cloned stack.
string[]? CloneAppIds { get; }Property Value
string[]
Remarks
ClonePermissions
If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions.
object? ClonePermissions { get; }Property Value
Remarks
ConfigurationManager
The configuration manager.
object? ConfigurationManager { get; }Property Value
Remarks
When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.
CustomCookbooksSource
Contains the information required to retrieve an app or cookbook from a repository.
object? CustomCookbooksSource { get; }Property Value
Remarks
CustomJson
A string that contains user-defined, custom JSON.
object? CustomJson { get; }Property Value
Remarks
It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:
"{"key1": "value1", "key2": "value2",...}"
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes .
DefaultAvailabilityZone
The stack's default Availability Zone, which must be in the specified region.
string? DefaultAvailabilityZone { get; }Property Value
Remarks
For more information, see Regions and Endpoints . If you also specify a value for DefaultSubnetId , the subnet must be in the same zone. For more information, see the VpcId parameter description.
DefaultInstanceProfileArn
The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.
string DefaultInstanceProfileArn { get; }Property Value
Remarks
For more information about IAM ARNs, see Using Identifiers .
DefaultOs
The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance.
string? DefaultOs { get; }Property Value
Remarks
You can specify one of the following.
The default option is the current Amazon Linux version. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems .
DefaultRootDeviceType
The default root device type.
string? DefaultRootDeviceType { get; }Property Value
Remarks
This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store . For more information, see Storage for the Root Device .
DefaultSshKeyName
A default Amazon EC2 key pair name.
string? DefaultSshKeyName { get; }Property Value
Remarks
The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access . You can override this setting by specifying a different key pair, or no key pair, when you create an instance .
DefaultSubnetId
The stack's default subnet ID.
string? DefaultSubnetId { get; }Property Value
Remarks
All instances are launched into this subnet unless you specify another subnet ID when you create the instance. This parameter is required if you specify a value for the VpcId parameter. If you also specify a value for DefaultAvailabilityZone , the subnet must be in that zone.
EcsClusterArn
The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the AWS OpsWorks stack.
string? EcsClusterArn { get; }Property Value
Remarks
If you specify a cluster that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the cluster.
ElasticIps
A list of Elastic IP addresses to register with the AWS OpsWorks stack.
object? ElasticIps { get; }Property Value
Remarks
If you specify an IP address that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the IP address.
HostnameTheme
The stack's host name theme, with spaces replaced by underscores.
string? HostnameTheme { get; }Property Value
Remarks
The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent , which creates host names by appending integers to the layer's short name. The other themes are:
To obtain a generated host name, call GetHostNameSuggestion , which returns a host name based on the current theme.
Name
The stack name.
string Name { get; }Property Value
Remarks
Stack names can be a maximum of 64 characters.
RdsDbInstances
The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the AWS OpsWorks stack.
object? RdsDbInstances { get; }Property Value
Remarks
If you specify a database instance that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the database instance.
ServiceRoleArn
The stack's IAM role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf.
string ServiceRoleArn { get; }Property Value
Remarks
You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers .
SourceStackId
If you're cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone.
string? SourceStackId { get; }Property Value
Remarks
Tags
A map that contains tag keys and tag values that are attached to a stack or layer.
ICfnTag[]? Tags { get; }Property Value
ICfnTag[]
Remarks
UseCustomCookbooks
Whether the stack uses custom cookbooks.
object? UseCustomCookbooks { get; }Property Value
Remarks
UseOpsworksSecurityGroups
Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
object? UseOpsworksSecurityGroups { get; }Property Value
Remarks
AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:
For more information, see Create a New Stack .
VpcId
The ID of the VPC that the stack is to be launched into.
string? VpcId { get; }Property Value
Remarks
The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.
If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC . For more information about default VPC and EC2-Classic, see Supported Platforms .