@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateApiRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Creates a new Api resource to represent an API.
NOOP
Constructor and Description |
---|
CreateApiRequest() |
Modifier and Type | Method and Description |
---|---|
CreateApiRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
CreateApiRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
CreateApiRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getApiKeySelectionExpression()
An API key selection expression.
|
Cors |
getCorsConfiguration()
A CORS configuration.
|
String |
getCredentialsArn()
This property is part of quick create.
|
String |
getDescription()
The description of the API.
|
Boolean |
getDisableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default execute-api endpoint.
|
Boolean |
getDisableSchemaValidation()
Avoid validating models when creating a deployment.
|
String |
getName()
The name of the API.
|
String |
getProtocolType()
The API protocol.
|
String |
getRouteKey()
This property is part of quick create.
|
String |
getRouteSelectionExpression()
The route selection expression for the API.
|
Map<String,String> |
getTags()
The collection of tags.
|
String |
getTarget()
This property is part of quick create.
|
String |
getVersion()
A version identifier for the API.
|
int |
hashCode() |
Boolean |
isDisableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default execute-api endpoint.
|
Boolean |
isDisableSchemaValidation()
Avoid validating models when creating a deployment.
|
void |
setApiKeySelectionExpression(String apiKeySelectionExpression)
An API key selection expression.
|
void |
setCorsConfiguration(Cors corsConfiguration)
A CORS configuration.
|
void |
setCredentialsArn(String credentialsArn)
This property is part of quick create.
|
void |
setDescription(String description)
The description of the API.
|
void |
setDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default execute-api endpoint.
|
void |
setDisableSchemaValidation(Boolean disableSchemaValidation)
Avoid validating models when creating a deployment.
|
void |
setName(String name)
The name of the API.
|
void |
setProtocolType(String protocolType)
The API protocol.
|
void |
setRouteKey(String routeKey)
This property is part of quick create.
|
void |
setRouteSelectionExpression(String routeSelectionExpression)
The route selection expression for the API.
|
void |
setTags(Map<String,String> tags)
The collection of tags.
|
void |
setTarget(String target)
This property is part of quick create.
|
void |
setVersion(String version)
A version identifier for the API.
|
String |
toString()
Returns a string representation of this object.
|
CreateApiRequest |
withApiKeySelectionExpression(String apiKeySelectionExpression)
An API key selection expression.
|
CreateApiRequest |
withCorsConfiguration(Cors corsConfiguration)
A CORS configuration.
|
CreateApiRequest |
withCredentialsArn(String credentialsArn)
This property is part of quick create.
|
CreateApiRequest |
withDescription(String description)
The description of the API.
|
CreateApiRequest |
withDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default execute-api endpoint.
|
CreateApiRequest |
withDisableSchemaValidation(Boolean disableSchemaValidation)
Avoid validating models when creating a deployment.
|
CreateApiRequest |
withName(String name)
The name of the API.
|
CreateApiRequest |
withProtocolType(ProtocolType protocolType)
The API protocol.
|
CreateApiRequest |
withProtocolType(String protocolType)
The API protocol.
|
CreateApiRequest |
withRouteKey(String routeKey)
This property is part of quick create.
|
CreateApiRequest |
withRouteSelectionExpression(String routeSelectionExpression)
The route selection expression for the API.
|
CreateApiRequest |
withTags(Map<String,String> tags)
The collection of tags.
|
CreateApiRequest |
withTarget(String target)
This property is part of quick create.
|
CreateApiRequest |
withVersion(String version)
A version identifier for the API.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setApiKeySelectionExpression(String apiKeySelectionExpression)
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.public String getApiKeySelectionExpression()
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
public CreateApiRequest withApiKeySelectionExpression(String apiKeySelectionExpression)
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.public void setCorsConfiguration(Cors corsConfiguration)
A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
corsConfiguration
- A CORS configuration. Supported only for HTTP APIs. See Configuring
CORS for more information.public Cors getCorsConfiguration()
A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
public CreateApiRequest withCorsConfiguration(Cors corsConfiguration)
A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
corsConfiguration
- A CORS configuration. Supported only for HTTP APIs. See Configuring
CORS for more information.public void setCredentialsArn(String credentialsArn)
This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
credentialsArn
- This property is part of quick create. It specifies the credentials required for the integration, if any.
For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume,
use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from
the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services,
specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.public String getCredentialsArn()
This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
public CreateApiRequest withCredentialsArn(String credentialsArn)
This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
credentialsArn
- This property is part of quick create. It specifies the credentials required for the integration, if any.
For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume,
use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from
the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services,
specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.public void setDescription(String description)
The description of the API.
description
- The description of the API.public String getDescription()
The description of the API.
public CreateApiRequest withDescription(String description)
The description of the API.
description
- The description of the API.public void setDisableSchemaValidation(Boolean disableSchemaValidation)
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for WebSocket APIs.public Boolean getDisableSchemaValidation()
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
public CreateApiRequest withDisableSchemaValidation(Boolean disableSchemaValidation)
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for WebSocket APIs.public Boolean isDisableSchemaValidation()
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
public void setDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
disableExecuteApiEndpoint
- Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint.
To require that clients use a custom domain name to invoke your API, disable the default endpoint.public Boolean getDisableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
public CreateApiRequest withDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
disableExecuteApiEndpoint
- Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint.
To require that clients use a custom domain name to invoke your API, disable the default endpoint.public Boolean isDisableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
public void setName(String name)
The name of the API.
name
- The name of the API.public String getName()
The name of the API.
public CreateApiRequest withName(String name)
The name of the API.
name
- The name of the API.public void setProtocolType(String protocolType)
The API protocol.
protocolType
- The API protocol.ProtocolType
public String getProtocolType()
The API protocol.
ProtocolType
public CreateApiRequest withProtocolType(String protocolType)
The API protocol.
protocolType
- The API protocol.ProtocolType
public CreateApiRequest withProtocolType(ProtocolType protocolType)
The API protocol.
protocolType
- The API protocol.ProtocolType
public void setRouteKey(String routeKey)
This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
routeKey
- This property is part of quick create. If you don't specify a routeKey, a default route of $default is
created. The $default route acts as a catch-all for any request made to your API, for a particular stage.
The $default route key can't be modified. You can add routes after creating the API, and you can update
the route keys of additional routes. Supported only for HTTP APIs.public String getRouteKey()
This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
public CreateApiRequest withRouteKey(String routeKey)
This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
routeKey
- This property is part of quick create. If you don't specify a routeKey, a default route of $default is
created. The $default route acts as a catch-all for any request made to your API, for a particular stage.
The $default route key can't be modified. You can add routes after creating the API, and you can update
the route keys of additional routes. Supported only for HTTP APIs.public void setRouteSelectionExpression(String routeSelectionExpression)
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
routeSelectionExpression
- The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be
${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property
is required for WebSocket APIs.public String getRouteSelectionExpression()
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
public CreateApiRequest withRouteSelectionExpression(String routeSelectionExpression)
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
routeSelectionExpression
- The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be
${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property
is required for WebSocket APIs.public Map<String,String> getTags()
The collection of tags. Each tag element is associated with a given resource.
public void setTags(Map<String,String> tags)
The collection of tags. Each tag element is associated with a given resource.
tags
- The collection of tags. Each tag element is associated with a given resource.public CreateApiRequest withTags(Map<String,String> tags)
The collection of tags. Each tag element is associated with a given resource.
tags
- The collection of tags. Each tag element is associated with a given resource.public CreateApiRequest addTagsEntry(String key, String value)
public CreateApiRequest clearTagsEntries()
public void setTarget(String target)
This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
target
- This property is part of quick create. Quick create produces an API with an integration, a default
catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP
integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of
the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.public String getTarget()
This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
public CreateApiRequest withTarget(String target)
This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
target
- This property is part of quick create. Quick create produces an API with an integration, a default
catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP
integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of
the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.public void setVersion(String version)
A version identifier for the API.
version
- A version identifier for the API.public String getVersion()
A version identifier for the API.
public CreateApiRequest withVersion(String version)
A version identifier for the API.
version
- A version identifier for the API.public String toString()
toString
in class Object
Object.toString()
public CreateApiRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()