Package software.amazon.awscdk.services.oam

Interface CfnLinkProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnLinkProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.527Z") @Stability(Stable) public interface CfnLinkProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnLink.

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.oam.*;
 CfnLinkProps cfnLinkProps = CfnLinkProps.builder()
         .resourceTypes(List.of("resourceTypes"))
         .sinkIdentifier("sinkIdentifier")
         // the properties below are optional
         .labelTemplate("labelTemplate")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    CfnLinkProps.Builder
    A builder for CfnLinkProps
    static final class 
    CfnLinkProps.Jsii$Proxy
    An implementation for CfnLinkProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnLinkProps.Builder
    builder()
     
    default String
    getLabelTemplate()
    Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
    List<String>
    getResourceTypes()
    An array of strings that define which types of data that the source account shares with the monitoring account.
    String
    getSinkIdentifier()
    The ARN of the sink in the monitoring account that you want to link to.
    default Map<String,String>
    getTags()
    An array of key-value pairs to apply to the link.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getResourceTypes

      @Stability(Stable) @NotNull List<String> getResourceTypes()
      An array of strings that define which types of data that the source account shares with the monitoring account.

      Valid values are AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace .

    • getSinkIdentifier

      @Stability(Stable) @NotNull String getSinkIdentifier()
      The ARN of the sink in the monitoring account that you want to link to.

      You can use ListSinks to find the ARNs of sinks.

    • getLabelTemplate

      @Stability(Stable) @Nullable default String getLabelTemplate()
      Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

      You can include the following variables in your template:

      • $AccountName is the name of the account
      • $AccountEmail is a globally-unique email address, which includes the email domain, such as mariagarcia@example.com
      • $AccountEmailNoDomain is an email address without the domain name, such as mariagarcia

    • getTags

      @Stability(Stable) @Nullable default Map<String,String> getTags()
      An array of key-value pairs to apply to the link.

      For more information, see Tag .

    • builder

      @Stability(Stable) static CfnLinkProps.Builder builder()
      Returns:
      a CfnLinkProps.Builder of CfnLinkProps