AWS.Tools.CodeStarconnections.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CodeStarconnections</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CSTC.AddCSTCResourceTagCmdlet"> <summary> Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.AddCSTCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to which you want to add or update tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.AddCSTCResourceTagCmdlet.Tag"> <summary> <para> <para>The tags you want to modify or add to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.AddCSTCResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeStarconnections.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.AddCSTCResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.AddCSTCResourceTagCmdlet.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.CSTC.GetCSTCConnectionCmdlet"> <summary> Returns the connection ARN and details such as status, owner, and provider type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCConnectionCmdlet.ConnectionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Connection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeStarconnections.Model.GetConnectionResponse). Specifying the name of a property of type Amazon.CodeStarconnections.Model.GetConnectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionArn parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCConnectionListCmdlet"> <summary> Lists the connections associated with your account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCConnectionListCmdlet.HostArnFilter"> <summary> <para> <para>Filters the list of connections to those associated with a specified host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCConnectionListCmdlet.ProviderTypeFilter"> <summary> <para> <para>Filters the list of connections to those associated with a specified provider, such as Bitbucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCConnectionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCConnectionListCmdlet.NextToken"> <summary> <para> <para>The token that was returned from the previous <code>ListConnections</code> call, which can be used to return the next set of connections in the list.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCConnectionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Connections'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeStarconnections.Model.ListConnectionsResponse). Specifying the name of a property of type Amazon.CodeStarconnections.Model.ListConnectionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCConnectionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProviderTypeFilter parameter. The -PassThru parameter is deprecated, use -Select '^ProviderTypeFilter' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCConnectionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCHostCmdlet"> <summary> Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCHostCmdlet.HostArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the requested host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCHostCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeStarconnections.Model.GetHostResponse). Specifying the name of a property of type Amazon.CodeStarconnections.Model.GetHostResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCHostCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HostArn parameter. The -PassThru parameter is deprecated, use -Select '^HostArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCHostListCmdlet"> <summary> Lists the hosts associated with your account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCHostListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCHostListCmdlet.NextToken"> <summary> <para> <para>The token that was returned from the previous <code>ListHosts</code> call, which can be used to return the next set of hosts in the list.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCHostListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Hosts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeStarconnections.Model.ListHostsResponse). Specifying the name of a property of type Amazon.CodeStarconnections.Model.ListHostsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCHostListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCResourceTagListCmdlet"> <summary> Gets the set of key-value pairs (metadata) that are used to manage the resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCResourceTagListCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCResourceTagListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeStarconnections.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.CodeStarconnections.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.GetCSTCResourceTagListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCConnectionCmdlet"> <summary> Creates a connection that can then be given to other AWS services like CodePipeline so that it can access third-party code repositories. The connection is in pending status until the third-party connection handshake is completed from the console. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCConnectionCmdlet.ConnectionName"> <summary> <para> <para>The name of the connection to be created. The name must be unique in the calling AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCConnectionCmdlet.HostArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the host associated with the connection to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCConnectionCmdlet.ProviderType"> <summary> <para> <para>The name of the external provider where your third-party code repository is configured.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCConnectionCmdlet.Tag"> <summary> <para> <para>The key-value pair to use when tagging the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConnectionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeStarconnections.Model.CreateConnectionResponse). Specifying the name of a property of type Amazon.CodeStarconnections.Model.CreateConnectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionName parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCConnectionCmdlet.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.CSTC.NewCSTCHostCmdlet"> <summary> Creates a resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider. <note><para> A host created through the CLI or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by setting up the host in the console. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCHostCmdlet.Name"> <summary> <para> <para>The name of the host to be created. The name must be unique in the calling AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCHostCmdlet.ProviderEndpoint"> <summary> <para> <para>The endpoint of the infrastructure to be represented by the host after it is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCHostCmdlet.ProviderType"> <summary> <para> <para>The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCHostCmdlet.VpcConfiguration_SecurityGroupId"> <summary> <para> <para>The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCHostCmdlet.VpcConfiguration_SubnetId"> <summary> <para> <para>The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCHostCmdlet.Tag"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCHostCmdlet.VpcConfiguration_TlsCertificate"> <summary> <para> <para>The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCHostCmdlet.VpcConfiguration_VpcId"> <summary> <para> <para>The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCHostCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HostArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeStarconnections.Model.CreateHostResponse). Specifying the name of a property of type Amazon.CodeStarconnections.Model.CreateHostResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCHostCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.NewCSTCHostCmdlet.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.CSTC.RemoveCSTCConnectionCmdlet"> <summary> The connection to be deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.RemoveCSTCConnectionCmdlet.ConnectionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the connection to be deleted.</para><note><para>The ARN is never reused if the connection is deleted.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.RemoveCSTCConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeStarconnections.Model.DeleteConnectionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.RemoveCSTCConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionArn parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.RemoveCSTCConnectionCmdlet.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.CSTC.RemoveCSTCHostCmdlet"> <summary> The host to be deleted. Before you delete a host, all connections associated to the host must be deleted. <note><para> A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.RemoveCSTCHostCmdlet.HostArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the host to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.RemoveCSTCHostCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeStarconnections.Model.DeleteHostResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.RemoveCSTCHostCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HostArn parameter. The -PassThru parameter is deprecated, use -Select '^HostArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.RemoveCSTCHostCmdlet.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.CSTC.RemoveCSTCResourceTagCmdlet"> <summary> Removes tags from an AWS resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.RemoveCSTCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to remove tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.RemoveCSTCResourceTagCmdlet.TagKey"> <summary> <para> <para>The list of keys for the tags to be removed from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.RemoveCSTCResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeStarconnections.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.RemoveCSTCResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.RemoveCSTCResourceTagCmdlet.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.CSTC.UpdateCSTCHostCmdlet"> <summary> Updates a specified host with the provided configurations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.UpdateCSTCHostCmdlet.HostArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the host to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.UpdateCSTCHostCmdlet.ProviderEndpoint"> <summary> <para> <para>The URL or endpoint of the host to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.UpdateCSTCHostCmdlet.VpcConfiguration_SecurityGroupId"> <summary> <para> <para>The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.UpdateCSTCHostCmdlet.VpcConfiguration_SubnetId"> <summary> <para> <para>The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.UpdateCSTCHostCmdlet.VpcConfiguration_TlsCertificate"> <summary> <para> <para>The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.UpdateCSTCHostCmdlet.VpcConfiguration_VpcId"> <summary> <para> <para>The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.UpdateCSTCHostCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeStarconnections.Model.UpdateHostResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.UpdateCSTCHostCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HostArn parameter. The -PassThru parameter is deprecated, use -Select '^HostArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSTC.UpdateCSTCHostCmdlet.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> |