Package software.amazon.awscdk.services.devopsagent

Interface CfnService.ApiKeyDetailsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.ApiKeyDetailsProperty.Jsii$Proxy

Enclosing class:

CfnService

@Stability(Stable)
public static interface CfnService.ApiKeyDetailsProperty
extends software.amazon.jsii.JsiiSerializable

API key authentication details.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.devopsagent.*;
 ApiKeyDetailsProperty apiKeyDetailsProperty = ApiKeyDetailsProperty.builder()
         .apiKeyHeader("apiKeyHeader")
         .apiKeyName("apiKeyName")
         .apiKeyValue("apiKeyValue")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-apikeydetails.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnService.ApiKeyDetailsProperty.Builder	A builder for CfnService.ApiKeyDetailsProperty
static final class	CfnService.ApiKeyDetailsProperty.Jsii$Proxy	An implementation for CfnService.ApiKeyDetailsProperty

Method Summary

Modifier and Type	Method	Description
static CfnService.ApiKeyDetailsProperty.Builder	builder()
String	getApiKeyHeader()	HTTP header name to send the API key.
String	getApiKeyName()	User friendly API key name.
String	getApiKeyValue()	API key value.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiKeyHeader

@Stability(Stable)
@NotNull
String getApiKeyHeader()

HTTP header name to send the API key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-apikeydetails.html#cfn-devopsagent-service-apikeydetails-apikeyheader

getApiKeyName

@Stability(Stable)
@NotNull
String getApiKeyName()

User friendly API key name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-apikeydetails.html#cfn-devopsagent-service-apikeydetails-apikeyname

getApiKeyValue

@Stability(Stable)
@NotNull
String getApiKeyValue()

API key value.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-apikeydetails.html#cfn-devopsagent-service-apikeydetails-apikeyvalue

builder

@Stability(Stable)
static CfnService.ApiKeyDetailsProperty.Builder builder()

Returns:

a CfnService.ApiKeyDetailsProperty.Builder of CfnService.ApiKeyDetailsProperty