org.jclouds.ec2.features.SecurityGroupApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ec2 Show documentation
Show all versions of ec2 Show documentation
jclouds components to access an implementation of EC2
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jclouds.ec2.features;
import static org.jclouds.aws.reference.FormParameters.ACTION;
import java.util.Set;
import javax.inject.Named;
import javax.ws.rs.FormParam;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import org.jclouds.Fallbacks.EmptySetOnNotFoundOr404;
import org.jclouds.Fallbacks.VoidOnNotFoundOr404;
import org.jclouds.aws.filters.FormSigner;
import org.jclouds.ec2.binders.BindFiltersToIndexedFormParams;
import org.jclouds.ec2.binders.BindGroupNamesToIndexedFormParams;
import org.jclouds.ec2.binders.BindUserIdGroupPairToSourceSecurityGroupFormParams;
import org.jclouds.ec2.domain.SecurityGroup;
import org.jclouds.ec2.domain.UserIdGroupPair;
import org.jclouds.ec2.xml.DescribeSecurityGroupsResponseHandler;
import org.jclouds.javax.annotation.Nullable;
import org.jclouds.location.functions.RegionToEndpointOrProviderIfNull;
import org.jclouds.net.domain.IpProtocol;
import org.jclouds.rest.annotations.BinderParam;
import org.jclouds.rest.annotations.EndpointParam;
import org.jclouds.rest.annotations.Fallback;
import org.jclouds.rest.annotations.FormParams;
import org.jclouds.rest.annotations.RequestFilters;
import org.jclouds.rest.annotations.VirtualHost;
import org.jclouds.rest.annotations.XMLResponseParser;
import com.google.common.collect.Multimap;
/**
* Provides access to EC2 via their REST API.
*
*/
@RequestFilters(FormSigner.class)
@VirtualHost
public interface SecurityGroupApi {
/**
* Creates a new security group. Group names must be unique per identity.
*
* @param region
* Security groups are not copied across Regions. Instances within the Region cannot
* communicate with instances outside the Region using group-based firewall rules.
* Traffic from instances in another Region is seen as WAN bandwidth.
* @param name
* Name of the security group. Accepts alphanumeric characters, spaces, dashes, and
* underscores.
* @param description
* Description of the group. This is informational only. If the description contains
* spaces, you must enc lose it in single quotes (') or URL-encode it. Accepts
* alphanumeric characters, spaces, dashes, and underscores.
* @see #runInstances
* @see #describeSecurityGroups
* @see #authorizeSecurityGroupIngress
* @see #revokeSecurityGroupIngress
* @see #deleteSecurityGroup
*
* @see
*/
@Named("CreateSecurityGroup")
@POST
@Path("/")
@FormParams(keys = ACTION, values = "CreateSecurityGroup")
void createSecurityGroupInRegion(
@EndpointParam(parser = RegionToEndpointOrProviderIfNull.class) @Nullable String region,
@FormParam("GroupName") String name, @FormParam("GroupDescription") String description);
/**
* Deletes a security group that you own.
*
* @param region
* Security groups are not copied across Regions. Instances within the Region cannot
* communicate with instances outside the Region using group-based firewall rules.
* Traffic from instances in another Region is seen as WAN bandwidth.
* @param name
* Name of the security group to delete.
*
* @see #describeSecurityGroups
* @see #authorizeSecurityGroupIngress
* @see #revokeSecurityGroupIngress
* @see #createSecurityGroup
*
* @see
*/
@Named("DeleteSecurityGroup")
@POST
@Path("/")
@FormParams(keys = ACTION, values = "DeleteSecurityGroup")
@Fallback(VoidOnNotFoundOr404.class)
void deleteSecurityGroupInRegion(
@EndpointParam(parser = RegionToEndpointOrProviderIfNull.class) @Nullable String region, @FormParam("GroupName") String name);
/**
* Returns information about security groups that you own.
*
* @param region
* Security groups are not copied across Regions. Instances within the Region cannot
* communicate with instances outside the Region using group-based firewall rules.
* Traffic from instances in another Region is seen as WAN bandwidth.
* @param securityGroupNames
* Name of the security groups
*
* @see #createSecurityGroup
* @see #authorizeSecurityGroupIngress
* @see #revokeSecurityGroupIngress
* @see #deleteSecurityGroup
*
* @see
*/
@Named("DescribeSecurityGroups")
@POST
@Path("/")
@FormParams(keys = ACTION, values = "DescribeSecurityGroups")
@XMLResponseParser(DescribeSecurityGroupsResponseHandler.class)
@Fallback(EmptySetOnNotFoundOr404.class)
Set describeSecurityGroupsInRegion(
@EndpointParam(parser = RegionToEndpointOrProviderIfNull.class) @Nullable String region,
@BinderParam(BindGroupNamesToIndexedFormParams.class) String... securityGroupNames);
/**
* Returns information about security groups that you own.
*
* @param region
* Security groups are not copied across Regions. Instances within the Region cannot
* communicate with instances outside the Region using group-based firewall rules.
* Traffic from instances in another Region is seen as WAN bandwidth.
* @param filter
* Multimap of filter key/values.
*
* @see #createSecurityGroup
* @see #authorizeSecurityGroupIngress
* @see #revokeSecurityGroupIngress
* @see #deleteSecurityGroup
*
* @see
*/
@Named("DescribeSecurityGroups")
@POST
@Path("/")
@FormParams(keys = ACTION, values = "DescribeSecurityGroups")
@XMLResponseParser(DescribeSecurityGroupsResponseHandler.class)
@Fallback(EmptySetOnNotFoundOr404.class)
Set describeSecurityGroupsInRegionWithFilter(
@EndpointParam(parser = RegionToEndpointOrProviderIfNull.class) @Nullable String region,
@BinderParam(BindFiltersToIndexedFormParams.class) Multimap filter);
/**
*
* Adds permissions to a security group based on another group.
*
* @param region
* Security groups are not copied across Regions. Instances within the Region cannot
* communicate with instances outside the Region using group-based firewall rules.
* Traffic from instances in another Region is seen as WAN bandwidth.
* @param groupName
* Name of the group to modify. The name must be valid and belong to the identity
* @param sourceSecurityGroup
* group to associate with this group.
*
* @see #createSecurityGroup
* @see #describeSecurityGroups
* @see #revokeSecurityGroupIngress
* @see #deleteSecurityGroup
*
* @see
* Permissions are specified by the IP protocol (TCP, UDP or ICMP), the source of the request (by
* IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP
* and UDP), and the ICMP codes and types (for ICMP). When authorizing ICMP, -1 can be used as a
* wildcard in the type and code fields. Permission changes are propagated to instances within
* the security group as quickly as possible. However, depending on the number of instances, a
* small delay might occur.
*
* @param region
* Security groups are not copied across Regions. Instances within the Region cannot
* communicate with instances outside the Region using group-based firewall rules.
* Traffic from instances in another Region is seen as WAN bandwidth.
* @param groupName
* Name of the group to modify. The name must be valid and belong to the identity
* @param ipProtocol
* IP protocol.
* @param fromPort
* Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP
* type number of -1 indicates a wildcard (i.e., any ICMP type number).
* @param toPort
* End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1
* indicates a wildcard (i.e., any ICMP code).
* @param cidrIp
* CIDR range.
*
* @see #createSecurityGroup
* @see #describeSecurityGroups
* @see #revokeSecurityGroupIngress
* @see #deleteSecurityGroup
*
* @see
* Permissions are specified by IP protocol (TCP, UDP, or ICMP), the source of the request (by IP
* range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and
* UDP), and the ICMP codes and types (for ICMP).
*
* Permission changes are quickly propagated to instances within the security group. However,
* depending on the number of instances in the group, a small delay is might occur.
*
* @param region
* Security groups are not copied across Regions. Instances within the Region cannot
* communicate with instances outside the Region using group-based firewall rules.
* Traffic from instances in another Region is seen as WAN bandwidth.
* @param groupName
* Name of the group to modify. The name must be valid and belong to the identity
* @param ipProtocol
* IP protocol.
* @param fromPort
* Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP
* type number of -1 indicates a wildcard (i.e., any ICMP type number).
* @param toPort
* End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1
* indicates a wildcard (i.e., any ICMP code).
* @param cidrIp
* CIDR range.
*
* @see #createSecurityGroup
* @see #describeSecurityGroups
* @see #authorizeSecurityGroupIngress
* @see #deleteSecurityGroup
*
* @see © 2015 - 2025 Weber Informatics LLC | Privacy Policy