Package software.amazon.awscdk.services.iot.actions.alpha

Class HttpsAction.Builder

java.lang.Object

software.amazon.awscdk.services.iot.actions.alpha.HttpsAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpsAction>

Enclosing class:

HttpsAction

@Stability(Experimental)
public static final class HttpsAction.Builder
extends Object
implements software.amazon.jsii.Builder<HttpsAction>

(experimental) A fluent builder for HttpsAction.

Method Summary

Modifier and Type	Method	Description
HttpsAction.Builder	auth(HttpActionSigV4Auth auth)	(experimental) Use Sigv4 authorization.
HttpsAction	build()
HttpsAction.Builder	confirmationUrl(String confirmationUrl)	(experimental) If specified, AWS IoT uses the confirmation URL to create a matching topic rule destination.
static HttpsAction.Builder	create(String url)
HttpsAction.Builder	headers(List<? extends HttpActionHeader> headers)	(experimental) The headers to include in the HTTPS request to the endpoint.
HttpsAction.Builder	role(IRole role)	(experimental) The IAM role that allows access to AWS service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Experimental)
public static HttpsAction.Builder create(String url)

Parameters:

url - The url to which to send post request. This parameter is required.

Returns:

a new instance of HttpsAction.Builder.

role

@Stability(Experimental)
public HttpsAction.Builder role(IRole role)

(experimental) The IAM role that allows access to AWS service.

Default: a new role will be created

Parameters:

role - The IAM role that allows access to AWS service. This parameter is required.

Returns:

this

auth

@Stability(Experimental)
public HttpsAction.Builder auth(HttpActionSigV4Auth auth)

(experimental) Use Sigv4 authorization.

Parameters:

auth - Use Sigv4 authorization. This parameter is required.

Returns:

this

confirmationUrl

@Stability(Experimental)
public HttpsAction.Builder confirmationUrl(String confirmationUrl)

(experimental) If specified, AWS IoT uses the confirmation URL to create a matching topic rule destination.

Parameters:

confirmationUrl - If specified, AWS IoT uses the confirmation URL to create a matching topic rule destination. This parameter is required.

Returns:

this

headers

@Stability(Experimental)
public HttpsAction.Builder headers(List<? extends HttpActionHeader> headers)

(experimental) The headers to include in the HTTPS request to the endpoint.

Parameters:

headers - The headers to include in the HTTPS request to the endpoint. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public HttpsAction build()

Specified by:

build in interface software.amazon.jsii.Builder<HttpsAction>

Returns:

a newly built instance of HttpsAction.