Interface CfnStackProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnStackProps.Jsii$Proxy
CfnStack.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.opsworks.*;
Object customJson;
CfnStackProps cfnStackProps = CfnStackProps.builder()
.defaultInstanceProfileArn("defaultInstanceProfileArn")
.name("name")
.serviceRoleArn("serviceRoleArn")
// the properties below are optional
.agentVersion("agentVersion")
.attributes(Map.of(
"attributesKey", "attributes"))
.chefConfiguration(ChefConfigurationProperty.builder()
.berkshelfVersion("berkshelfVersion")
.manageBerkshelf(false)
.build())
.cloneAppIds(List.of("cloneAppIds"))
.clonePermissions(false)
.configurationManager(StackConfigurationManagerProperty.builder()
.name("name")
.version("version")
.build())
.customCookbooksSource(SourceProperty.builder()
.password("password")
.revision("revision")
.sshKey("sshKey")
.type("type")
.url("url")
.username("username")
.build())
.customJson(customJson)
.defaultAvailabilityZone("defaultAvailabilityZone")
.defaultOs("defaultOs")
.defaultRootDeviceType("defaultRootDeviceType")
.defaultSshKeyName("defaultSshKeyName")
.defaultSubnetId("defaultSubnetId")
.ecsClusterArn("ecsClusterArn")
.elasticIps(List.of(ElasticIpProperty.builder()
.ip("ip")
// the properties below are optional
.name("name")
.build()))
.hostnameTheme("hostnameTheme")
.rdsDbInstances(List.of(RdsDbInstanceProperty.builder()
.dbPassword("dbPassword")
.dbUser("dbUser")
.rdsDbInstanceArn("rdsDbInstanceArn")
.build()))
.sourceStackId("sourceStackId")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.useCustomCookbooks(false)
.useOpsworksSecurityGroups(false)
.vpcId("vpcId")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnStackPropsstatic final classAn implementation forCfnStackProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnStackProps.Builderbuilder()default StringThe default OpsWorks Stacks agent version.default ObjectOne or more user-defined key-value pairs to be added to the stack attributes.default ObjectAChefConfigurationobject that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.If you're cloning an OpsWorks stack, a list of OpsWorks application stack IDs from the source stack to include in the cloned stack.default ObjectIf you're cloning an OpsWorks stack, indicates whether to clone the source stack's permissions.default ObjectThe configuration manager.default ObjectContains the information required to retrieve an app or cookbook from a repository.default ObjectA string that contains user-defined, custom JSON.default StringThe stack's default Availability Zone, which must be in the specified region.The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.default StringThe stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance.default StringThe default root device type.default StringA default Amazon EC2 key pair name.default StringThe stack's default subnet ID.default StringThe Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the OpsWorks stack.default ObjectA list of Elastic IP addresses to register with the OpsWorks stack.default StringThe stack's host name theme, with spaces replaced by underscores.getName()The stack name.default ObjectThe Amazon Relational Database Service ( Amazon RDS ) database instance to register with the OpsWorks stack.The stack's IAM role, which allows OpsWorks Stacks to work with AWS resources on your behalf.default StringIf you're cloning an OpsWorks stack, the stack ID of the source OpsWorks stack to clone.getTags()A map that contains tag keys and tag values that are attached to a stack or layer.default ObjectWhether the stack uses custom cookbooks.default ObjectWhether to associate the OpsWorks Stacks built-in security groups with the stack's layers.default StringgetVpcId()The ID of the VPC that the stack is to be launched into.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDefaultInstanceProfileArn
The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.For more information about IAM ARNs, see Using Identifiers .
- See Also:
-
getName
The stack name.Stack names can be a maximum of 64 characters.
- See Also:
-
getServiceRoleArn
The stack's IAM role, which allows OpsWorks Stacks to work with AWS resources on your behalf.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 .
- See Also:
-
getAgentVersion
The default OpsWorks Stacks agent version. You have the following options:.- Auto-update - Set this parameter to
LATEST. OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. - Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. OpsWorks Stacks installs that version on the stack's instances.
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.
- See Also:
- Auto-update - Set this parameter to
-
getAttributes
One or more user-defined key-value pairs to be added to the stack attributes.Returns union: either Mapinvalid input: '<'String,
String> orIResolvable- See Also:
-
getChefConfiguration
AChefConfigurationobject that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack .Returns union: either
IResolvableorCfnStack.ChefConfigurationProperty- See Also:
-
getCloneAppIds
If you're cloning an OpsWorks stack, a list of OpsWorks application stack IDs from the source stack to include in the cloned stack.- See Also:
-
getClonePermissions
If you're cloning an OpsWorks stack, indicates whether to clone the source stack's permissions.Returns union: either
BooleanorIResolvable- See Also:
-
getConfigurationManager
The configuration manager.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.
Returns union: either
IResolvableorCfnStack.StackConfigurationManagerProperty- See Also:
-
getCustomCookbooksSource
Contains the information required to retrieve an app or cookbook from a repository.For more information, see Adding Apps or Cookbooks and Recipes .
Returns union: either
IResolvableorCfnStack.SourceProperty- See Also:
-
getCustomJson
A string that contains user-defined, custom JSON.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 .
- See Also:
-
getDefaultAvailabilityZone
The stack's default Availability Zone, which must be in the specified region.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 theVpcIdparameter description.- See Also:
-
getDefaultOs
The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance.You can specify one of the following.
- A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2,Amazon Linux 2018.03,Amazon Linux 2017.09,Amazon Linux 2017.03,Amazon Linux 2016.09,Amazon Linux 2016.03,Amazon Linux 2015.09, orAmazon Linux 2015.03. - A supported Ubuntu operating system, such as
Ubuntu 18.04 LTS,Ubuntu 16.04 LTS,Ubuntu 14.04 LTS, orUbuntu 12.04 LTS. CentOS Linux 7Red Hat Enterprise Linux 7- A supported Windows operating system, such as
Microsoft Windows Server 2012 R2 Base,Microsoft Windows Server 2012 R2 with SQL Server Express,Microsoft Windows Server 2012 R2 with SQL Server Standard, orMicrosoft Windows Server 2012 R2 with SQL Server Web. - A custom AMI:
Custom. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs .
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 OpsWorks Stacks Operating Systems .
- See Also:
- A supported Linux operating system: An Amazon Linux version, such as
-
getDefaultRootDeviceType
The default root device type.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 .- See Also:
-
getDefaultSshKeyName
A default Amazon EC2 key pair name.The default value is none. If you specify a key pair name, 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 .
- See Also:
-
getDefaultSubnetId
The stack's default subnet ID.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
VpcIdparameter. If you also specify a value forDefaultAvailabilityZone, the subnet must be in that zone.- See Also:
-
getEcsClusterArn
The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the OpsWorks stack.If you specify a cluster that's registered with another OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the cluster.
- See Also:
-
getElasticIps
A list of Elastic IP addresses to register with the OpsWorks stack.If you specify an IP address that's registered with another OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the IP address.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnStack.ElasticIpProperty>- See Also:
-
getHostnameTheme
The stack's host name theme, with spaces replaced by underscores.The theme is used to generate host names for the stack's instances. By default,
HostnameThemeis set toLayer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:Baked_GoodsCloudsEurope_CitiesFruitsGreek_Deities_and_TitansLegendary_creatures_from_JapanPlanets_and_MoonsRoman_DeitiesScottish_IslandsUS_CitiesWild_Cats
To obtain a generated host name, call
GetHostNameSuggestion, which returns a host name based on the current theme.- See Also:
-
getRdsDbInstances
The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the OpsWorks stack.If you specify a database instance that's registered with another OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the database instance.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnStack.RdsDbInstanceProperty>- See Also:
-
getSourceStackId
If you're cloning an OpsWorks stack, the stack ID of the source OpsWorks stack to clone.- See Also:
-
getTags
A map that contains tag keys and tag values that are attached to a stack or layer.- The key cannot be empty.
- The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters:
+ - = . _ : / - The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters:
+ - = . _ : / - Leading and trailing white spaces are trimmed from both the key and value.
- A maximum of 40 tags is allowed for any resource.
- See Also:
-
getUseCustomCookbooks
Whether the stack uses custom cookbooks.Returns union: either
BooleanorIResolvable- See Also:
-
getUseOpsworksSecurityGroups
Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With
UseOpsworksSecurityGroupsyou can instead provide your own custom security groups.UseOpsworksSecurityGroupshas the following settings:- True - OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
- False - OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack .
Returns union: either
BooleanorIResolvable- See Also:
-
getVpcId
The ID of the VPC that the stack is to be launched into.The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.
- If your account supports EC2-Classic, the default value is
no VPC. - If your account does not support EC2-Classic, the default value is the default VPC for the specified region.
If the VPC ID corresponds to a default VPC and you have specified either the
DefaultAvailabilityZoneor theDefaultSubnetIdparameter only, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, 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:
- It must belong to a VPC in your account that is in the specified region.
- You must specify a value for
DefaultSubnetId.
For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a VPC . For more information about default VPC and EC2-Classic, see Supported Platforms .
- See Also:
- If your account supports EC2-Classic, the default value is
-
builder
- Returns:
- a
CfnStackProps.BuilderofCfnStackProps
-