< Back
Add-CfnIAM_AccessKeyResource
Post
NAME Add-CfnIAM_AccessKeyResource
SYNOPSIS
The AWS::IAM::AccessKey resource type generates a secret access key and assigns it to an IAM user or AWS account.
SYNTAX
Add-CfnIAM_AccessKeyResource [-ResourceName] <String> [-Serial <String>] [-Status <String>] [-UserName <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
-Serial <String>
This value is specific to AWS CloudFormation and can only be incremented. Incrementing this value notifies AWS
CloudFormation that you want to rotate your access key. When you update your stack, AWS CloudFormation will
replace the existing access key with a new key.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Status <String>
The status of the access key.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserName <String>
The name of the user that the new key will belong to.
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 ... :AccessKey
SYNOPSIS
The AWS::IAM::AccessKey resource type generates a secret access key and assigns it to an IAM user or AWS account.
SYNTAX
Add-CfnIAM_AccessKeyResource [-ResourceName] <String> [-Serial <String>] [-Status <String>] [-UserName <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
-Serial <String>
This value is specific to AWS CloudFormation and can only be incremented. Incrementing this value notifies AWS
CloudFormation that you want to rotate your access key. When you update your stack, AWS CloudFormation will
replace the existing access key with a new key.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Status <String>
The status of the access key.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserName <String>
The name of the user that the new key will belong to.
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 ... :AccessKey