Package software.amazon.awscdk.cfnpropertymixins.services.grafana

Interface CfnWorkspacePropsMixin.IdpMetadataProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkspacePropsMixin.IdpMetadataProperty.Jsii$Proxy

Enclosing class:

CfnWorkspacePropsMixin

@Stability(Stable)
public static interface CfnWorkspacePropsMixin.IdpMetadataProperty
extends software.amazon.jsii.JsiiSerializable

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

You can specify the metadata either by providing a URL to its location in the url parameter, or by specifying the full metadata in XML format in the xml parameter. Specifying both will cause an error.

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.grafana.*;
 IdpMetadataProperty idpMetadataProperty = IdpMetadataProperty.builder()
         .url("url")
         .xml("xml")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-idpmetadata.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWorkspacePropsMixin.IdpMetadataProperty.Builder	builder()
default String	getUrl()	The URL of the location containing the IdP metadata.
default String	getXml()	The full IdP metadata, in XML format.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUrl

@Stability(Stable)
@Nullable
default String getUrl()

The URL of the location containing the IdP metadata.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-idpmetadata.html#cfn-grafana-workspace-idpmetadata-url

getXml

@Stability(Stable)
@Nullable
default String getXml()

The full IdP metadata, in XML format.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-idpmetadata.html#cfn-grafana-workspace-idpmetadata-xml

builder

@Stability(Stable)
static CfnWorkspacePropsMixin.IdpMetadataProperty.Builder builder()

Returns:

a CfnWorkspacePropsMixin.IdpMetadataProperty.Builder of CfnWorkspacePropsMixin.IdpMetadataProperty