< Back

Add-CfnOpsWorks_StackResource

Sat Jan 11, 2020 7:16 am

NAME Add-CfnOpsWorks_StackResource



SYNOPSIS

Creates an AWS OpsWorks stack. An AWS OpsWorks stack represents a set of instances that you want to manage

collectively, typically because they have a common purpose such as serving PHP applications.





SYNTAX

Add-CfnOpsWorks_StackResource [-ResourceName] <String> [-AgentVersion <String>] [-Attributes <Object>]

[-ChefConfiguration <IDictionary>] [-ConfigurationManager <IDictionary>] [-CustomCookbooksSource <IDictionary>]

[-CustomJson <Object>] [-DefaultAvailabilityZone <String>] [-DefaultInstanceProfileArn <String>] [-DefaultOs

<String>] [-DefaultRootDeviceType <String>] [-DefaultSshKeyName <String>] [-DefaultSubnetId <String>]

[-HostnameTheme <String>] [-Name <String>] [-ServiceRoleArn <String>] [-UseCustomCookbooks <Boolean>]

[-UseOpsworksSecurityGroups <Boolean>] [-VpcId <String>] [-DeletionPolicy <String>] [-Metadata <Hashtable>]

[-DependsOn <Array>] [[-PropertiesBlock] <ScriptBlock>] [-Condition <Object>] [<CommonParameters>]





DESCRIPTION





PARAMETERS

-ResourceName <String>



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AgentVersion <String>

The AWS OpsWorks agent version that you want to use. The agent communicates with the service and handles tasks

such as initiating Chef runs in response to lifecycle events.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Attributes <Object>

One or more user-defined key-value pairs to be added to the stack attributes bag.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ChefConfiguration <IDictionary>

Describes the Chef configuration.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ConfigurationManager <IDictionary>

The configuration manager. When you create a stack, you use the configuration manager to specify the Chef

version.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CustomCookbooksSource <IDictionary>

Contains the information required to retrieve a cookbook from a repository.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CustomJson <Object>

A string that contains user-defined custom JSON. The custom JSON is used to override the corresponding default

stack configuration JSON values.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DefaultAvailabilityZone <String>

The stack's default Availability Zone, which must be in the specified region.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DefaultInstanceProfileArn <String>

The Amazon Resource Name (ARN) of an IAM instance profile that is the default profile for all of the stack's

Amazon EC2 instances.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DefaultOs <String>

The stack's default operating system.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DefaultRootDeviceType <String>

The default root device type. This value is used by default for all instances in the stack, but you can

override it when you create an instance.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DefaultSshKeyName <String>

A default SSH key for the stack instances. You can override this value when you create or update an instance.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DefaultSubnetId <String>

The stack's default subnet ID. All instances are launched into this subnet unless you specify another subnet

ID when you create the instance.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-HostnameTheme <String>

The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for

the stack's instances.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

The name of the AWS OpsWorks stack.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ServiceRoleArn <String>

The AWS Identity and Access Management (IAM) role that AWS OpsWorks uses to work with AWS resources on your

behalf. You must specify an Amazon Resource Name (ARN) for an existing IAM role.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-UseCustomCookbooks <Boolean>

Whether the stack uses custom cookbooks.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-UseOpsworksSecurityGroups <Boolean>

Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-VpcId <String>

The ID of the VPC that the stack is to be launched into, which must be in the specified region. All instances

are launched into this VPC.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DeletionPolicy <String>

With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is

deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has

no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.



To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any

resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to

use or modify those resources after you delete their stacks.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Metadata <Hashtable>

The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata

attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use

intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute

to add those interpreted values.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DependsOn <Array>

With the DependsOn attribute you can specify that the creation of a specific resource follows another. When

you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource

specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PropertiesBlock <ScriptBlock>

Allows you to declare a block of one or more Property statements.



A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,

and specify Property assignments that may include CloudFormation function calls or references, or computed

values.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Condition <Object>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS





RELATED LINKS

http://docs.aws.amazon.com/AWSCloudForm ... olicy.html

http://docs.aws.amazon.com/AWSCloudForm ... adata.html

http://docs.aws.amazon.com/AWSCloudForm ... ndson.html

http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html

http://docs.aws.amazon.com/search/doc-s ... rks::Stack