< Back

Add-CfnOpsWorks_LayerResource

Sat Jan 11, 2020 7:15 am

NAME Add-CfnOpsWorks_LayerResource



SYNOPSIS

Creates an AWS OpsWorks layer. A layer defines, for example, which packages and applications are installed and how

they are configured.





SYNTAX

Add-CfnOpsWorks_LayerResource [-ResourceName] <String> [-Attributes <Object>] [-AutoAssignElasticIps <Boolean>]

[-AutoAssignPublicIps <Boolean>] [-CustomInstanceProfileArn <String>] [-CustomRecipes <IDictionary>]

[-CustomSecurityGroupIds <String[]>] [-EnableAutoHealing <Boolean>] [-InstallUpdatesOnBoot <Boolean>]

[-LifecycleEventConfiguration <IDictionary>] [-LoadBasedAutoScaling <IDictionary>] [-Name <String>] [-Packages

<String[]>] [-Shortname <String>] [-StackId <String>] [-Type <String>] [-VolumeConfigurations <IDictionary>]

[-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



-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



-AutoAssignElasticIps <Boolean>

Whether to automatically assign an Elastic IP address to Amazon EC2 instances in this layer.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-AutoAssignPublicIps <Boolean>

For AWS OpsWorks stacks that are running in a VPC, whether to automatically assign a public IP address to

Amazon EC2 instances in this layer.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-CustomInstanceProfileArn <String>

The Amazon Resource Name (ARN) of an IAM instance profile that is to be used for the Amazon EC2 instances in

this layer.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CustomRecipes <IDictionary>

Custom event recipes for this layer.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CustomSecurityGroupIds <String[]>

Custom security group IDs for this layer.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-EnableAutoHealing <Boolean>

Whether to automatically heal Amazon EC2 instances that have become disconnected or timed out.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-InstallUpdatesOnBoot <Boolean>

Whether to install operating system and package updates when the instance boots.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-LifecycleEventConfiguration <IDictionary>

The lifecycle events for the AWS OpsWorks layer.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-LoadBasedAutoScaling <IDictionary>

The load-based scaling configuration for the AWS OpsWorks layer.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

The AWS OpsWorks layer name.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Packages <String[]>

The packages for this layer.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Shortname <String>

The layer short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also

used as the name for the directory where your app files are installed.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-StackId <String>

The ID of the AWS OpsWorks stack that this layer will be associated with.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Type <String>

The layer type. A stack cannot have more than one layer of the same type.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-VolumeConfigurations <IDictionary>

Describes the Amazon EBS volumes for this layer.



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::Layer