< Back
Add-CfnOpsWorks_InstanceResource
Post
NAME Add-CfnOpsWorks_InstanceResource
SYNOPSIS
Creates an instance for an AWS OpsWorks stack. These instances represent the Amazon EC2 instances that, for
example, handle the work of serving applications and balancing traffic.
SYNTAX
Add-CfnOpsWorks_InstanceResource [-ResourceName] <String> [-AmiId <String>] [-Architecture <String>]
[-AvailabilityZone <String>] [-EbsOptimized <Boolean>] [-InstallUpdatesOnBoot <Boolean>] [-InstanceType <String>]
[-LayerIds <String[]>] [-Os <String>] [-RootDeviceType <String>] [-SshKeyName <String>] [-StackId <String>]
[-SubnetId <String>] [-TimeBasedAutoScaling <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
-AmiId <String>
The ID of the custom AMI to be used to create the instance. The AMI should be based on one of the standard AWS
OpsWorks APIs.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Architecture <String>
The instance architecture.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AvailabilityZone <String>
The instance Availability Zone.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EbsOptimized <Boolean>
Whether the instance is optimized for Amazon Elastic Block Store (Amazon EBS) I/O.
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
-InstanceType <String>
The instance type, which must be supported by AWS OpsWorks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LayerIds <String[]>
The IDs of the AWS OpsWorks layers that will be associated with this instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Os <String>
The instance operating system.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RootDeviceType <String>
The instance root device type.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SshKeyName <String>
The instance SSH key name.
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 instance will be associated with.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SubnetId <String>
The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the
stack's default subnet ID value and direct AWS OpsWorks to launch the instance in a different subnet.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TimeBasedAutoScaling <IDictionary>
The time-based scaling configuration for the instance.
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 ... ::Instance
SYNOPSIS
Creates an instance for an AWS OpsWorks stack. These instances represent the Amazon EC2 instances that, for
example, handle the work of serving applications and balancing traffic.
SYNTAX
Add-CfnOpsWorks_InstanceResource [-ResourceName] <String> [-AmiId <String>] [-Architecture <String>]
[-AvailabilityZone <String>] [-EbsOptimized <Boolean>] [-InstallUpdatesOnBoot <Boolean>] [-InstanceType <String>]
[-LayerIds <String[]>] [-Os <String>] [-RootDeviceType <String>] [-SshKeyName <String>] [-StackId <String>]
[-SubnetId <String>] [-TimeBasedAutoScaling <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
-AmiId <String>
The ID of the custom AMI to be used to create the instance. The AMI should be based on one of the standard AWS
OpsWorks APIs.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Architecture <String>
The instance architecture.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AvailabilityZone <String>
The instance Availability Zone.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EbsOptimized <Boolean>
Whether the instance is optimized for Amazon Elastic Block Store (Amazon EBS) I/O.
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
-InstanceType <String>
The instance type, which must be supported by AWS OpsWorks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LayerIds <String[]>
The IDs of the AWS OpsWorks layers that will be associated with this instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Os <String>
The instance operating system.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RootDeviceType <String>
The instance root device type.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SshKeyName <String>
The instance SSH key name.
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 instance will be associated with.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SubnetId <String>
The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the
stack's default subnet ID value and direct AWS OpsWorks to launch the instance in a different subnet.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TimeBasedAutoScaling <IDictionary>
The time-based scaling configuration for the instance.
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 ... ::Instance