AWS.Tools.CodeStar.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CodeStar</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CST.AddCSTTagsForProjectCmdlet"> <summary> Adds tags to a project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.AddCSTTagsForProjectCmdlet.Id"> <summary> <para> <para>The ID of the project you want to add a tag to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.AddCSTTagsForProjectCmdlet.Tag"> <summary> <para> <para>The tags you want to add to the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.AddCSTTagsForProjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.AddCSTTeamMemberCmdlet"> <summary> Adds an IAM user to the team for an AWS CodeStar project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.AddCSTTeamMemberCmdlet.ClientRequestToken"> <summary> <para> <para>A user- or system-generated token that identifies the entity that requested the team member association to the project. This token can be used to repeat the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.AddCSTTeamMemberCmdlet.ProjectId"> <summary> <para> <para>The ID of the project to which you will add the IAM user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.AddCSTTeamMemberCmdlet.ProjectRole"> <summary> <para> <para>The AWS CodeStar project role that will apply to this user. This role determines what actions a user can take in an AWS CodeStar project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.AddCSTTeamMemberCmdlet.RemoteAccessAllowed"> <summary> <para> <para>Whether the team member is allowed to use an SSH public/private key pair to remotely access project resources, for example Amazon EC2 instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.AddCSTTeamMemberCmdlet.UserArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.AddCSTTeamMemberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.GetCSTProjectCmdlet"> <summary> Describes a project and its resources. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTProjectCmdlet.Id"> <summary> <para> <para>The ID of the project.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.GetCSTProjectListCmdlet"> <summary> Lists all projects in AWS CodeStar associated with your AWS account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTProjectListCmdlet.MaxResult"> <summary> <para> <para>The maximum amount of data that can be contained in a single set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTProjectListCmdlet.NextToken"> <summary> <para> <para>The continuation token to be used to return the next set of results, if the results cannot be returned in one response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.GetCSTResourceListCmdlet"> <summary> Lists resources associated with a project in AWS CodeStar.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTResourceListCmdlet.ProjectId"> <summary> <para> <para>The ID of the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTResourceListCmdlet.MaxResult"> <summary> <para> <para>The maximum amount of data that can be contained in a single set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTResourceListCmdlet.NextToken"> <summary> <para> <para>The continuation token for the next set of results, if the results cannot be returned in one response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.GetCSTTagsForProjectCmdlet"> <summary> Gets the tags for a project.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTTagsForProjectCmdlet.Id"> <summary> <para> <para>The ID of the project to get tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTTagsForProjectCmdlet.MaxResult"> <summary> <para> <para>Reserved for future use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTTagsForProjectCmdlet.NextToken"> <summary> <para> <para>Reserved for future use.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.GetCSTTeamMemberListCmdlet"> <summary> Lists all team members associated with a project.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTTeamMemberListCmdlet.ProjectId"> <summary> <para> <para>The ID of the project for which you want to list team members.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTTeamMemberListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of team members you want returned in a response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTTeamMemberListCmdlet.NextToken"> <summary> <para> <para>The continuation token for the next set of results, if the results cannot be returned in one response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.GetCSTUserProfileCmdlet"> <summary> Describes a user in AWS CodeStar and the user attributes across all projects. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTUserProfileCmdlet.UserArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the user.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.GetCSTUserProfileListCmdlet"> <summary> Lists all the user profiles configured for your AWS account in AWS CodeStar.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTUserProfileListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.GetCSTUserProfileListCmdlet.NextToken"> <summary> <para> <para>The continuation token for the next set of results, if the results cannot be returned in one response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.NewCSTProjectCmdlet"> <summary> Creates a project, including project resources. This action creates a project based on a submitted project request. A set of source code files and a toolchain template file can be included with the project request. If these are not provided, an empty project is created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTProjectCmdlet.S3_BucketKey"> <summary> <para> <para>The Amazon S3 object key where the source code files provided with the project request are stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTProjectCmdlet.S3_BucketName"> <summary> <para> <para>The Amazon S3 bucket name where the source code files provided with the project request are stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTProjectCmdlet.ClientRequestToken"> <summary> <para> <para>A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTProjectCmdlet.Description"> <summary> <para> <para>The description of the project, if any.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTProjectCmdlet.Id"> <summary> <para> <para>The ID of the project to be created in AWS CodeStar.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTProjectCmdlet.Name"> <summary> <para> <para>The display name for the project to be created in AWS CodeStar.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTProjectCmdlet.Toolchain_RoleArn"> <summary> <para> <para>The service role ARN for AWS CodeStar to use for the toolchain template during stack provisioning.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTProjectCmdlet.SourceCode"> <summary> <para> <para>A list of the Code objects submitted with the project request. If this parameter is specified, the request must also include the toolchain parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTProjectCmdlet.Toolchain_StackParameter"> <summary> <para> <para>The list of parameter overrides to be passed into the toolchain template during stack provisioning, if any.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTProjectCmdlet.Tag"> <summary> <para> <para>The tags created for the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTProjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.NewCSTUserProfileCmdlet"> <summary> Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTUserProfileCmdlet.DisplayName"> <summary> <para> <para>The name that will be displayed as the friendly name for the user in AWS CodeStar. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTUserProfileCmdlet.EmailAddress"> <summary> <para> <para>The email address that will be displayed as part of the user's profile in AWS CodeStar.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTUserProfileCmdlet.SshPublicKey"> <summary> <para> <para>The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTUserProfileCmdlet.UserArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the user in IAM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.NewCSTUserProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.RemoveCSTProjectCmdlet"> <summary> Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.RemoveCSTProjectCmdlet.ClientRequestToken"> <summary> <para> <para>A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.RemoveCSTProjectCmdlet.DeleteStack"> <summary> <para> <para>Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources. This option will delete all AWS resources for the project (except for any buckets in Amazon S3) as well as deleting the project itself. Recommended for most use cases.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.RemoveCSTProjectCmdlet.Id"> <summary> <para> <para>The ID of the project to be deleted in AWS CodeStar.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.RemoveCSTProjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.RemoveCSTTagsForProjectCmdlet"> <summary> Removes tags from a project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.RemoveCSTTagsForProjectCmdlet.Id"> <summary> <para> <para>The ID of the project to remove tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.RemoveCSTTagsForProjectCmdlet.Tag"> <summary> <para> <para>The tags to remove from the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.RemoveCSTTagsForProjectCmdlet.PassThru"> <summary> Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.RemoveCSTTagsForProjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.RemoveCSTTeamMemberCmdlet"> <summary> Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user's profile from AWS CodeStar. It does not remove the user from IAM. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.RemoveCSTTeamMemberCmdlet.ProjectId"> <summary> <para> <para>The ID of the AWS CodeStar project from which you want to remove a team member.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.RemoveCSTTeamMemberCmdlet.UserArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove from the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.RemoveCSTTeamMemberCmdlet.PassThru"> <summary> Returns the value passed to the UserArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.RemoveCSTTeamMemberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.RemoveCSTUserProfileCmdlet"> <summary> Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.RemoveCSTUserProfileCmdlet.UserArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.RemoveCSTUserProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.UpdateCSTProjectCmdlet"> <summary> Updates a project in AWS CodeStar. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTProjectCmdlet.Description"> <summary> <para> <para>The description of the project, if any.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTProjectCmdlet.Id"> <summary> <para> <para>The ID of the project you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTProjectCmdlet.Name"> <summary> <para> <para>The name of the project you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTProjectCmdlet.PassThru"> <summary> Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTProjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.UpdateCSTTeamMemberCmdlet"> <summary> Updates a team member's attributes in an AWS CodeStar project. For example, you can change a team member's role in the project, or change whether they have remote access to project resources. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTTeamMemberCmdlet.ProjectId"> <summary> <para> <para>The ID of the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTTeamMemberCmdlet.ProjectRole"> <summary> <para> <para>The role assigned to the user in the project. Project roles have different levels of access. For more information, see <a href="http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html">Working with Teams</a> in the <i>AWS CodeStar User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTTeamMemberCmdlet.RemoteAccessAllowed"> <summary> <para> <para>Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile. Even if this is set to True, the user must associate a public key with their profile before the user can access resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTTeamMemberCmdlet.UserArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTTeamMemberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CST.UpdateCSTUserProfileCmdlet"> <summary> Updates a user's profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTUserProfileCmdlet.DisplayName"> <summary> <para> <para>The name that is displayed as the friendly name for the user in AWS CodeStar.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTUserProfileCmdlet.EmailAddress"> <summary> <para> <para>The email address that is displayed as part of the user's profile in AWS CodeStar.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTUserProfileCmdlet.SshPublicKey"> <summary> <para> <para>The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTUserProfileCmdlet.UserArn"> <summary> <para> <para>The name that will be displayed as the friendly name for the user in AWS CodeStar.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CST.UpdateCSTUserProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |