Package software.amazon.smithy.aws.cloudformation.traits

Class CfnResource

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CfnResource.Builder  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static CfnResource.Builder builder()  
      java.util.List<java.util.Set<java.lang.String>> getAdditionalIdentifiers()
      Get a list of sets of member shape ids, each set can be used to identify the CloudFormation resource in addition to its primary identifier(s).
      java.util.Set<java.lang.String> getCreateOnlyProperties()
      Get create-specifiable-only property definitions of the CloudFormation resource.
      java.util.Set<ShapeId> getExcludedProperties()
      Get members that have been explicitly excluded from the CloudFormation resource.
      java.util.Set<java.lang.String> getPrimaryIdentifiers()
      Gets a set of identifier names that represent the primary way to identify a CloudFormation resource.
      java.util.Map<java.lang.String,​CfnResourceProperty> getProperties()
      Get all property definitions of the CloudFormation resource.
      java.util.Optional<CfnResourceProperty> getProperty​(java.lang.String propertyName)
      Gets the definition of the specified property of the CloudFormation resource.
      java.util.Set<java.lang.String> getReadOnlyProperties()
      Get read-only property definitions of the CloudFormation resource.
      java.util.Set<java.lang.String> getWriteOnlyProperties()
      Get write-only property definitions of the CloudFormation resource.
      CfnResource.Builder toBuilder()
      Take this object and create a builder that contains all of the current property values of this object.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getProperties

        public java.util.Map<java.lang.String,​CfnResourceProperty> getProperties()
        Get all property definitions of the CloudFormation resource.

        Properties excluded by the cfnExcludedProperty trait are not returned.

        Returns:
        Returns all members that map to CloudFormation resource properties.
        See Also:
        getExcludedProperties()

      • getProperty

        public java.util.Optional<CfnResourceProperty> getProperty​(java.lang.String propertyName)
        Gets the definition of the specified property of the CloudFormation resource.

        An empty Optional will be returned if the requested property has been excluded by the cfnExcludedProperty trait.

        Parameters:
        propertyName - Name of the property to retrieve
        Returns:
        The property definition.
        See Also:
        getExcludedProperties()

      • getCreateOnlyProperties

        public java.util.Set<java.lang.String> getCreateOnlyProperties()
        Get create-specifiable-only property definitions of the CloudFormation resource. These properties can be specified only during resource creation and can be returned in a read or list request.
        Returns:
        Returns create-only member names that map to CloudFormation resource properties.

      • getReadOnlyProperties

        public java.util.Set<java.lang.String> getReadOnlyProperties()
        Get read-only property definitions of the CloudFormation resource. These properties can be returned by a read or list request, but cannot be set by the user.
        Returns:
        Returns read-only member names that map to CloudFormation resource properties.

      • getWriteOnlyProperties

        public java.util.Set<java.lang.String> getWriteOnlyProperties()
        Get write-only property definitions of the CloudFormation resource. These properties can be specified by the user, but cannot be returned by a read or list request.
        Returns:
        Returns write-only member names that map to CloudFormation resource properties.

      • getExcludedProperties

        public java.util.Set<ShapeId> getExcludedProperties()
        Get members that have been explicitly excluded from the CloudFormation resource.
        Returns:
        Returns members that have been excluded from a CloudFormation resource.

      • getPrimaryIdentifiers

        public java.util.Set<java.lang.String> getPrimaryIdentifiers()
        Gets a set of identifier names that represent the primary way to identify a CloudFormation resource. This uniquely identifies an individual instance of the resource type, and can be one or more properties to represent composite-key identifiers.
        Returns:
        Returns the identifier set primarily used to access a CloudFormation resource.

      • getAdditionalIdentifiers

        public java.util.List<java.util.Set<java.lang.String>> getAdditionalIdentifiers()
        Get a list of sets of member shape ids, each set can be used to identify the CloudFormation resource in addition to its primary identifier(s).
        Returns:
        Returns identifier sets used to access a CloudFormation resource.