@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-31T18:36:49.405Z")
public interface CfnStackProps
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnStackProps.Builder
A builder for
CfnStackProps |
static class |
CfnStackProps.Jsii$Proxy
An implementation for
CfnStackProps |
Modifier and Type | Method and Description |
---|---|
static CfnStackProps.Builder |
builder() |
default java.lang.String |
getAgentVersion()
The default AWS OpsWorks Stacks agent version.
|
default java.lang.Object |
getAttributes()
One or more user-defined key-value pairs to be added to the stack attributes.
|
default java.lang.Object |
getChefConfiguration()
A `ChefConfiguration` object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.
|
default java.util.List<java.lang.String> |
getCloneAppIds()
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.
|
default java.lang.Object |
getClonePermissions()
If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions.
|
default java.lang.Object |
getConfigurationManager()
The configuration manager.
|
default java.lang.Object |
getCustomCookbooksSource()
Contains the information required to retrieve an app or cookbook from a repository.
|
default java.lang.Object |
getCustomJson()
A string that contains user-defined, custom JSON.
|
default java.lang.String |
getDefaultAvailabilityZone()
The stack's default Availability Zone, which must be in the specified region.
|
java.lang.String |
getDefaultInstanceProfileArn()
The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.
|
default java.lang.String |
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.
|
default java.lang.String |
getDefaultRootDeviceType()
The default root device type.
|
default java.lang.String |
getDefaultSshKeyName()
A default Amazon EC2 key pair name.
|
default java.lang.String |
getDefaultSubnetId()
The stack's default subnet ID.
|
default java.lang.String |
getEcsClusterArn()
The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the AWS OpsWorks stack.
|
default java.lang.Object |
getElasticIps()
A list of Elastic IP addresses to register with the AWS OpsWorks stack.
|
default java.lang.String |
getHostnameTheme()
The stack's host name theme, with spaces replaced by underscores.
|
java.lang.String |
getName()
The stack name.
|
default java.lang.Object |
getRdsDbInstances()
The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the AWS OpsWorks stack.
|
java.lang.String |
getServiceRoleArn()
The stack's IAM role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf.
|
default java.lang.String |
getSourceStackId()
If you're cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone.
|
default java.util.List<CfnTag> |
getTags()
A map that contains tag keys and tag values that are attached to a stack or layer.
|
default java.lang.Object |
getUseCustomCookbooks()
Whether the stack uses custom cookbooks.
|
default java.lang.Object |
getUseOpsworksSecurityGroups()
Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
|
default java.lang.String |
getVpcId()
The ID of the VPC that the stack is to be launched into.
|
java.lang.String getDefaultInstanceProfileArn()
For more information about IAM ARNs, see Using Identifiers .
java.lang.String getName()
Stack names can be a maximum of 64 characters.
java.lang.String getServiceRoleArn()
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 .
default java.lang.String getAgentVersion()
LATEST
. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.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.
default java.lang.Object getAttributes()
default java.lang.Object getChefConfiguration()
default java.util.List<java.lang.String> getCloneAppIds()
default java.lang.Object getClonePermissions()
default java.lang.Object getConfigurationManager()
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.
default java.lang.Object getCustomCookbooksSource()
For more information, see Adding Apps or Cookbooks and Recipes .
default java.lang.Object getCustomJson()
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 .
default java.lang.String getDefaultAvailabilityZone()
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.
default java.lang.String getDefaultOs()
You can specify one of the following.
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
, or Amazon Linux 2015.03
.Ubuntu 18.04 LTS
, Ubuntu 16.04 LTS
, Ubuntu 14.04 LTS
, or Ubuntu 12.04 LTS
.CentOS Linux 7
Red Hat Enterprise Linux 7
Microsoft Windows Server 2012 R2 Base
, Microsoft Windows Server 2012 R2 with SQL Server Express
, Microsoft Windows Server 2012 R2 with SQL Server Standard
, or Microsoft Windows Server 2012 R2 with SQL Server Web
.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 AWS OpsWorks Stacks Operating Systems .
default java.lang.String getDefaultRootDeviceType()
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 .
default java.lang.String getDefaultSshKeyName()
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 .
default java.lang.String getDefaultSubnetId()
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.
default java.lang.String getEcsClusterArn()
If you specify a cluster that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the cluster.
default java.lang.Object getElasticIps()
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.
default java.lang.String getHostnameTheme()
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:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities_and_Titans
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion
, which returns a host name based on the current theme.
default java.lang.Object getRdsDbInstances()
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.
default java.lang.String getSourceStackId()
default java.util.List<CfnTag> getTags()
+ - = . _ : /
+ - = . _ : /
default java.lang.Object getUseCustomCookbooks()
default java.lang.Object getUseOpsworksSecurityGroups()
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 .
default java.lang.String getVpcId()
The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.
no VPC
.
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:
DefaultSubnetId
.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 .
static CfnStackProps.Builder builder()
CfnStackProps.Builder
of CfnStackProps