AWS.Tools.S3Outposts.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.S3Outposts</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.S3O.GetS3OEndpointListCmdlet"> <summary> Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html"> Accessing S3 on Outposts using VPC only access points</a>. <para> This action lists endpoints associated with the Outposts. </para><para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html">CreateEndpoint</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html">DeleteEndpoint</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.GetS3OEndpointListCmdlet.MaxResult"> <summary> <para> <para>The max number of endpoints that can be returned on the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.GetS3OEndpointListCmdlet.NextToken"> <summary> <para> <para>The next endpoint requested in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.GetS3OEndpointListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Endpoints'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Outposts.Model.ListEndpointsResponse). Specifying the name of a property of type Amazon.S3Outposts.Model.ListEndpointsResponse 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="T:Amazon.PowerShell.Cmdlets.S3O.NewS3OEndpointCmdlet"> <summary> Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html"> Accessing S3 on Outposts using VPC only access points</a>. <para> This action creates an endpoint and associates it with the specified Outposts. </para><note><para> It can take up to 5 minutes for this action to complete. </para></note><para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html">DeleteEndpoint</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html">ListEndpoints</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.NewS3OEndpointCmdlet.AccessType"> <summary> <para> <para>The type of access for the on-premise network connectivity for the Outpost endpoint. To access the endpoint from an on-premises network, you must specify the access type and provide the customer owned IPv4 pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.NewS3OEndpointCmdlet.CustomerOwnedIpv4Pool"> <summary> <para> <para>The ID of the customer-owned IPv4 pool for the endpoint. IP addresses will be allocated from this pool for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.NewS3OEndpointCmdlet.OutpostId"> <summary> <para> <para>The ID of the AWS Outposts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.NewS3OEndpointCmdlet.SecurityGroupId"> <summary> <para> <para>The ID of the security group to use with the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.NewS3OEndpointCmdlet.SubnetId"> <summary> <para> <para>The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has the Amazon S3 on Outposts provisioned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.NewS3OEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Outposts.Model.CreateEndpointResponse). Specifying the name of a property of type Amazon.S3Outposts.Model.CreateEndpointResponse 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.S3O.NewS3OEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OutpostId parameter. The -PassThru parameter is deprecated, use -Select '^OutpostId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.NewS3OEndpointCmdlet.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.S3O.RemoveS3OEndpointCmdlet"> <summary> Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html"> Accessing S3 on Outposts using VPC only access points</a>. <para> This action deletes an endpoint. </para><note><para> It can take up to 5 minutes for this action to complete. </para></note><para> Related actions include: </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html">CreateEndpoint</a></para></li><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html">ListEndpoints</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.RemoveS3OEndpointCmdlet.EndpointId"> <summary> <para> <para>The ID of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.RemoveS3OEndpointCmdlet.OutpostId"> <summary> <para> <para>The ID of the AWS Outposts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.RemoveS3OEndpointCmdlet.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.S3Outposts.Model.DeleteEndpointResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.RemoveS3OEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointId parameter. The -PassThru parameter is deprecated, use -Select '^EndpointId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3O.RemoveS3OEndpointCmdlet.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> |