Package software.amazon.awscdk.cfnpropertymixins.services.devopsagent

Interface CfnServicePropsMixin.ApiKeyDetailsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServicePropsMixin.ApiKeyDetailsProperty.Jsii$Proxy

Enclosing class:

CfnServicePropsMixin

@Stability(Stable)
public static interface CfnServicePropsMixin.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.cfnpropertymixins.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	CfnServicePropsMixin.ApiKeyDetailsProperty.Builder	A builder for CfnServicePropsMixin.ApiKeyDetailsProperty
static final class	CfnServicePropsMixin.ApiKeyDetailsProperty.Jsii$Proxy	An implementation for CfnServicePropsMixin.ApiKeyDetailsProperty

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiKeyHeader

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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 CfnServicePropsMixin.ApiKeyDetailsProperty.Builder builder()

Returns:

a CfnServicePropsMixin.ApiKeyDetailsProperty.Builder of CfnServicePropsMixin.ApiKeyDetailsProperty